diff options
author | Eduardo Julian | 2022-11-07 18:52:46 -0400 |
---|---|---|
committer | Eduardo Julian | 2022-11-07 18:52:46 -0400 |
commit | cb572295c9a73330531e07f3f6a92b3bb2434514 (patch) | |
tree | ae14be0a53235971d897c033879e3d4512ffde68 /stdlib/source/documentation/lux/data/collection/stream.lux | |
parent | 13c594758482bac0a7550bcb89cfeda8c5f0a1f3 (diff) |
Can now mark definitions as deprecated in their documentation.
Diffstat (limited to 'stdlib/source/documentation/lux/data/collection/stream.lux')
-rw-r--r-- | stdlib/source/documentation/lux/data/collection/stream.lux | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/stdlib/source/documentation/lux/data/collection/stream.lux b/stdlib/source/documentation/lux/data/collection/stream.lux index d32960d0d..cef25618b 100644 --- a/stdlib/source/documentation/lux/data/collection/stream.lux +++ b/stdlib/source/documentation/lux/data/collection/stream.lux @@ -29,33 +29,33 @@ ($.definition /.iterations "A stateful way of infinitely calculating the values of a stream." - [(iterations step init)]) + ($.example (iterations step init))) ($.definition /.repeated "Repeat a value forever." - [(repeated x)]) + ($.example (repeated x))) ($.definition /.cycle "Go over the elements of a list forever." - [(cycle [start next])]) + ($.example (cycle [start next]))) ($.definition /.item "" - [(item idx stream)]) + ($.example (item idx stream))) ($.definition /.only "A new stream only with items that satisfy the predicate." - [(only predicate stream)]) + ($.example (only predicate stream))) ($.definition /.partition (format "Split a stream in two based on a predicate." \n "The left side contains all entries for which the predicate is #1." \n "The right side contains all entries for which the predicate is #0.") - [(partition left? xs)]) + ($.example (partition left? xs))) ($.definition /.pattern (format "Allows destructuring of streams in pattern-matching expressions." \n "Caveat emptor: Only use it for destructuring, and not for testing values within the streams.") - [(let [(pattern x y z _tail) (some_stream_func +1 +2 +3)] - (func x y z))]) + ($.example (let [(pattern x y z _tail) (some_stream_func +1 +2 +3)] + (func x y z)))) )) |