Skip to content

Commit 7b6d48c

Browse files
authored
fix the docstring signature of getfield (#59605)
When both `order` and `boundscheck` arguments are given to a `getfield` call, the order need to be `order` -> `boundscheck`. The docstring should reflect this.
1 parent 12f7bb5 commit 7b6d48c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

base/docs/basedocs.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2470,15 +2470,15 @@ julia> Tuple(Real[1, 2, pi]) # takes a collection
24702470
tuple
24712471

24722472
"""
2473-
getfield(value, name::Symbol, [boundscheck::Bool=true], [order::Symbol])
2474-
getfield(value, i::Int, [boundscheck::Bool=true], [order::Symbol])
2473+
getfield(value, name::Symbol, [order::Symbol], [boundscheck::Bool=true])
2474+
getfield(value, i::Int, [order::Symbol], [boundscheck::Bool=true])
24752475
24762476
Extract a field from a composite `value` by name or position.
24772477
2478-
Optionally, an ordering can be defined for the operation. If the field was
2479-
declared `@atomic`, the specification is strongly recommended to be compatible
2480-
with the stores to that location. Otherwise, if not declared as `@atomic`, this
2481-
parameter must be `:not_atomic` if specified.
2478+
Optionally, an ordering can be defined for the operation.
2479+
If the field was declared `@atomic`, the specification is strongly recommended to be
2480+
compatible with the stores to that location.
2481+
Otherwise, if not declared as `@atomic`, this parameter must be `:not_atomic` if specified.
24822482
24832483
The bounds check may be disabled, in which case the behavior of this function is
24842484
undefined if `i` is out of bounds.

0 commit comments

Comments
 (0)