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

converted julia-repl to jldoctest in variables.md #56995

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

converted julia-repl to jldoctest in variables.md #56995

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/src/manual/variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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

julia> x = 10
10
Expand Down Expand Up @@ -119,7 +119,7 @@ it from `+ ᵃx` where `ᵃx` is the variable name.

A particular class of variable names is one that contains only underscores. These identifiers are write-only. I.e. they can only be assigned values, which are immediately discarded, and their values cannot be used in any way.

```julia-repl
```jldoctest
julia> x, ___ = size([2 2; 1 1])
(2, 2)

Expand All @@ -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

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

julia> else = false
ERROR: syntax: unexpected "else"

Expand Down
Loading