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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

xyz-harshal
Copy link

@xyz-harshal xyz-harshal commented Jan 8, 2025

Details:

  • Converted julia-repl to jldoctest in variables.md
  • I tried only on variable.md file to check whether what i did is correct or not. If the changes are correct I'll try to convert every julia-repl to jldoctest
  • @LilithHafner , @inkydragon could you please review?

Tickets:

@LilithHafner LilithHafner added the docs This change adds or pertains to documentation label Jan 8, 2025
@LilithHafner
Copy link
Member

Thanks for working on this!

Those julia-repl blocks are not currently accurate to the actual Julia REPL. Making them jldoctests tells Documenter to test that they are accurate, so doctests will fail.

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
Copy link
Member

@inkydragon inkydragon Jan 8, 2025

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

Copy link
Member

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
Copy link
Member

Choose a reason for hiding this comment

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

Need to update output

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants