Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update basedocs.jl for $ #34035

Merged
merged 1 commit into from
Dec 10, 2019
Merged

Update basedocs.jl for $ #34035

merged 1 commit into from
Dec 10, 2019

Conversation

Delta456
Copy link
Contributor

@Delta456 Delta456 commented Dec 6, 2019 •
edited
Loading

Task for Google Code In 2019

Add docstring of '$' for interpolation at the REPL. Solves #33666

@Delta456
Copy link
Contributor Author

Delta456 commented Dec 6, 2019

Need help with falling builds

@fredrikekre fredrikekre added the docs This change adds or pertains to documentation label Dec 6, 2019
@Delta456
Copy link
Contributor Author

Delta456 commented Dec 6, 2019

Could anyone help me what's wrong?

@jaideep-seth
Copy link
Contributor

jaideep-seth commented Dec 6, 2019 •
edited
Loading

Take at solving part of #33666 . This is the Google Code-in task (https://codein.withgoogle.com/dashboard/task-instances/5757413873942528/)

Hi @Delta456, please add a description for your pull request to enable other members to help.

Please use this page for the docstring description for '$' - (https://github.com/JuliaLang/julia/blob/master/doc/src/base/punctuation.md)

abhishalya
abhishalya reviewed Dec 6, 2019
View reviewed changes
@jaideep-seth
Copy link
Contributor

jaideep-seth commented Dec 6, 2019 •
edited
Loading

Please see the basedocs.jl of this merged pull request (https://github.com/JuliaLang/julia/pull/33344/files)

@ViralBShah
Copy link
Member

A big welcome to all the Code-In contributors.

abhishalya
abhishalya suggested changes Dec 7, 2019
View reviewed changes
base/docs/basedocs.jl Outdated

# Examples
```jldoctest
julia> name = Joe
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incorrect. It should be name = "Joe"

base/docs/basedocs.jl Outdated
# Examples
```jldoctest
julia> name = Joe
Joe
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here too: "Joe"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

damn

@abhishalya
Copy link

Also, this needs a rebase.

abhishalya
abhishalya suggested changes Dec 7, 2019
View reviewed changes
@jaideep-seth
Copy link
Contributor

jaideep-seth commented Dec 8, 2019 •
edited
Loading

Hi @Delta456 , this is a sample PR that I've made (#33824), please get your basedocs.jl correct. Create an issue for your failing builds ( this is a sample I've created [https://github.com//issues/33844] ) and i will accept the task!

@Delta456
Copy link
Contributor Author

Delta456 commented Dec 8, 2019 •
edited
Loading

@jaideep-seth I think the compiler should also allow "$" instead of giving an error for string interpolation and I have copied the PR exactly as shown.

abhishalya
abhishalya suggested changes Dec 8, 2019
View reviewed changes
abhishalya
abhishalya suggested changes Dec 8, 2019
View reviewed changes
base/docs/basedocs.jl Outdated
@@ -447,6 +447,23 @@ julia> A'
"""
kw"'"

"""
"\$"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No " " here please. This should be just \$

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why

@jaideep-seth
Copy link
Contributor

Hello @abhishalya & @Delta456 , please take up some of these task instances - (https://codein.withgoogle.com/tasks/5659574762209280/?sp-page=5)

@abhishalya
Copy link

@jaideep-seth Thanks, but I think I might just leave that for new people since we've already done some Beginner tasks.

StefanKarpinski
StefanKarpinski approved these changes Dec 9, 2019
View reviewed changes
Copy link
Member

@StefanKarpinski StefanKarpinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Thanks for the doc improvement. Anyone familiar with documenter stuff know if this is the right way to attach docs to the $ symbol? Maybe @fredrikekre?

@fredrikekre fredrikekre self-assigned this Dec 9, 2019
abhishalya
abhishalya suggested changes Dec 10, 2019
View reviewed changes
Copy link

@abhishalya abhishalya left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a rebase!

Also, it would be much better to have the commits squashed into one.

@StefanKarpinski
Copy link
Member

It's easy to squash the commits into a single one through the GitHub interface, so don't worry about that :)

@fredrikekre fredrikekre merged commit a633deb into JuliaLang:master Dec 10, 2019
KristofferC pushed a commit that referenced this pull request Apr 11, 2020
@Delta456 @KristofferC
Add documentation for $ as interpolation operator. (#34035)
f837532
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abhishalya abhishalya abhishalya requested changes

@StefanKarpinski StefanKarpinski StefanKarpinski approved these changes

Assignees

@fredrikekre fredrikekre

Labels
docs This change adds or pertains to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Delta456 @jaideep-seth @ViralBShah @abhishalya @StefanKarpinski @fredrikekre