Skip to content

Commit

Permalink
Remove cmp argument from replacefield! docstring (#41282)
Browse files Browse the repository at this point in the history
  • Loading branch information
jpsamaroo authored Jun 20, 2021
1 parent 9d5f31e commit 153f908
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions base/docs/basedocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2005,22 +2005,22 @@ optimized to the appropriate hardware instruction, otherwise it'll use a loop.
modifyfield!

"""
replacefield!(value, name::Symbol, cmp, expected, desired,
replacefield!(value, name::Symbol, expected, desired,
[success_order::Symbol, [fail_order::Symbol=success_order]) =>
(old, Bool)
These atomically perform the operations to get and conditionally set a field to
a given value.
y = getfield!(value, name, fail_order)
ok = cmp(y, expected)
ok = y === expected
if ok
setfield!(value, name, desired, success_order)
end
return y, ok
If the operation is `===` on a supported type, we'll use the relevant processor
instructions, otherwise it'll use a loop.
If supported by the hardware, this may be optimized to the appropriate hardware
instruction, otherwise it'll use a loop.
"""
replacefield!

Expand Down

0 comments on commit 153f908

Please sign in to comment.