-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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.
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
converted julia-repl to jldoctest in variables.md #56995
base: master
Are you sure you want to change the base?
Conversation
Thanks for working on this! Those This means that in addition to changing the tag, you'll need to change their content to match an actual REPL session. For comments, putting the comment at the end of the line should work. For errors, you may re-run the existing code in the REPL to see the latest error messages (thanks to parser improvements by @c42f, some of those errors are much more descriptive now). Finally, you may want to read https://documenter.juliadocs.org/stable/man/doctests/#Exceptions to see how to omit stack traces (stack traces change frequently as line numbers shift and we don't want doctests to fail when that happens). |
@@ -3,7 +3,7 @@ | |||
A variable, in Julia, is a name associated (or bound) to a value. It's useful when you want to | |||
store a value (that you obtained after some math, for example) for later use. For example: | |||
|
|||
```julia-repl | |||
```jldoctest | |||
# Assign the value 10 to the variable x |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if doctest allow comments here.
Seems not allowed here.
https://buildkite.com/julialang/julia-master/builds/43583#0194466c-f9d5-413d-b167-37588f60ddc1/816-915
Perhaps we could move these comments to the back of the code.
julia> x = 1 # Assign x
1
@@ -132,7 +132,7 @@ ERROR: syntax: all-underscore identifiers are write-only and their values cannot | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update output:
julia> x, ___ = size([2 2; 1 1])
(2, 2)
julia> y = ___
ERROR: syntax: all-underscore identifiers are write-only and their values cannot be used in expressions
Stacktrace:
[1] top-level scope
@ REPL[27]:1
julia> println(___)
ERROR: syntax: all-underscore identifiers are write-only and their values cannot be used in expressions
Stacktrace:
[1] top-level scope
@ REPL[28]:1
Maybe something like:
julia> x, ___ = size([2 2; 1 1])
(2, 2)
julia> y = ___
ERROR: syntax: all-underscore identifiers are write-only and their values cannot be used in expressions
[...]
julia> println(___)
ERROR: syntax: all-underscore identifiers are write-only and their values cannot be used in expressions
[...]
See doctest
in Documentation · The Julia Language
@@ -132,7 +132,7 @@ ERROR: syntax: all-underscore identifiers are write-only and their values cannot | |||
|
|||
The only explicitly disallowed names for variables are the names of the built-in [Keywords](@ref Keywords): | |||
|
|||
```julia-repl | |||
```jldoctest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update output
Details:
julia-repl
tojldoctest
in variables.mdjulia-repl
tojldoctest
Tickets:
jldoctest
wherever possible #56921