Skip to content

Commit

Permalink
Avoid "In the current implementation," conditional
Browse files Browse the repository at this point in the history
  • Loading branch information
tkf committed May 11, 2022
1 parent 59bbcf4 commit dfe5eea
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 @@ -2758,10 +2758,10 @@ The syntax `@atomic! max(a().b, c)` returns `modifyproperty!(a(), :b,
max, c, :sequentially_consistent))`, where the first argument must be a
`getfield` expression and is modified atomically.
In the current implementation, the default implementation of `modifyproperty!` does not call
`convert` automatically and an exception is thrown if `op` returns a value that cannot be
stored in the field `f` of the object `x`. This is different from the behavior of the
default [`setproperty!`](@ref Base.setproperty!).
Invocation of `op(getproperty(x, f), v)` must return a value that can be stored in the field
`f` of the object `x` by default. In particular, unlike the default behavior of
[`setproperty!`](@ref Base.setproperty!), the `convert` function is not called
automatically.
See also [`modifyfield!`](@ref Core.modifyfield!)
and [`setproperty!`](@ref Base.setproperty!).
Expand Down

0 comments on commit dfe5eea

Please sign in to comment.