Skip to content

Commit 6f41fc4

Browse files
committed
docs: improve wording
1 parent 2f67e6d commit 6f41fc4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/ComposableExpression.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -296,16 +296,16 @@ The .valid field tracks whether any upstream computation failed (false = failed,
296296
Wrap your vectors in ValidVector:
297297
298298
```julia
299-
valid_ar = ValidVector(ar, all(isfinite, ar))
300-
valid_ar + my_validvector
299+
valid_ar1 = ValidVector(ar1, all(isfinite, ar1))
300+
valid_ar1 + valid_ar2
301301
```
302302
303303
Alternatively, you can access the vector from a ValidVector with `my_validvector.x`,
304304
but you must be sure to propagate the `.valid` field. For example:
305305
306306
```julia
307-
out = my_validvector.x .+ my_vector
308-
ValidVector(out, my_validvector.valid && all(isfinite, out))
307+
out = ar1 .+ valid_ar2.x
308+
ValidVector(out, all(isfinite, out) && valid_ar2.valid)
309309
```
310310
311311
""",
@@ -321,9 +321,9 @@ ValidVectorAccessError: ValidVector doesn't support direct array operations.
321321
Use .x for data and .valid for validity:
322322
323323
```julia
324-
my_validvector.x[1] # indexing
325-
length(my_validvector.x) # length
326-
my_validvector.valid # check validity (false = any upstream computation failed)
324+
valid_ar.x[1] # indexing
325+
length(valid_ar.x) # length
326+
valid_ar.valid # check validity (false = any upstream computation failed)
327327
```
328328
329329
ValidVector handles validity/batching automatically in template expressions.""",

0 commit comments

Comments
 (0)