Merge pull request JuliaObjects#19 from JuliaObjects/jw3126-patch-1

Update optics.jl
aplavin · Mar 23, 2021 · 187aa28 · 187aa28
2 parents 12cb1d2 + c207cfd
commit 187aa28
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/optics.jl b/src/optics.jl
@@ -14,7 +14,8 @@ const EXPERIMENTAL = """This function/method/type is experimental. It can be cha
 """
     modify(f, obj, optic)
 
-Replace a deeply nested part `x` of `obj` by `f(x)`.
+Replace a part `x` of `obj` by `f(x)`. The `optic` argument selects
+which part to replace.
 
 ```jldoctest
 julia> using Accessors
@@ -29,9 +30,9 @@ See also [`set`](@ref).
 function modify end
 
 """
-    set(optic, obj, val)
+    set(obj, optic, val)
 
-Replace a deeply nested part of `obj` by `val`.
+Replace a part according to `optic` of `obj` by `val`.
 
 ```jldoctest
 julia> using Accessors