aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation
diff options
context:
space:
mode:
authorEduardo Julian2021-09-15 20:22:07 -0400
committerEduardo Julian2021-09-15 20:22:07 -0400
commit4f4656b278c6f9dfbdd15d5d9bc86d63c5b44333 (patch)
tree48360f77b72713c5e39f5a2ca937eef1b60fa7cd /stdlib/source/documentation
parent4559c124c01c6f513372fa1a4f7664e9f6a94ed8 (diff)
"Sequence" => "Stream"
Diffstat (limited to 'stdlib/source/documentation')
-rw-r--r--stdlib/source/documentation/lux/data/collection.lux4
-rw-r--r--stdlib/source/documentation/lux/data/collection/stream.lux (renamed from stdlib/source/documentation/lux/data/collection/sequence.lux)27
2 files changed, 15 insertions, 16 deletions
diff --git a/stdlib/source/documentation/lux/data/collection.lux b/stdlib/source/documentation/lux/data/collection.lux
index 7d4e0a6bc..9fae3d77f 100644
--- a/stdlib/source/documentation/lux/data/collection.lux
+++ b/stdlib/source/documentation/lux/data/collection.lux
@@ -14,7 +14,7 @@
["[1][0]" list]
["[1][0]" queue]
["[1][0]" row]
- ["[1][0]" sequence]
+ ["[1][0]" stream]
["[1][0]" stack]
["[1][0]" set]
["[1][0]" tree]])
@@ -28,7 +28,7 @@
/list.documentation
/queue.documentation
/row.documentation
- /sequence.documentation
+ /stream.documentation
/stack.documentation
/set.documentation
/tree.documentation
diff --git a/stdlib/source/documentation/lux/data/collection/sequence.lux b/stdlib/source/documentation/lux/data/collection/stream.lux
index 1bbf4db94..9486be114 100644
--- a/stdlib/source/documentation/lux/data/collection/sequence.lux
+++ b/stdlib/source/documentation/lux/data/collection/stream.lux
@@ -15,11 +15,11 @@
[\\library
["[0]" /]])
-(documentation: (/.Sequence it)
+(documentation: (/.Stream it)
"An infinite sequence of values.")
(documentation: /.iterations
- "A stateful way of infinitely calculating the values of a sequence."
+ "A stateful way of infinitely calculating the values of a stream."
[(iterations step init)])
(documentation: /.repeated
@@ -27,35 +27,34 @@
[(repeated x)])
(documentation: /.cycle
- (format "Go over the elements of a list forever."
- \n "The list should not be empty.")
+ "Go over the elements of a list forever."
[(cycle [start next])])
(documentation: /.item
""
- [(item idx sequence)])
+ [(item idx stream)])
(documentation: /.only
- "A new sequence only with items that satisfy the predicate."
- [(only predicate sequence)])
+ "A new stream only with items that satisfy the predicate."
+ [(only predicate stream)])
(documentation: /.partition
- (format "Split a sequence in two based on a predicate."
+ (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)])
-(documentation: /.^sequence&
- (format "Allows destructuring of sequences in pattern-matching expressions."
- \n "Caveat emptor: Only use it for destructuring, and not for testing values within the sequences.")
- [(let [(^sequence& x y z _tail) (some_sequence_func +1 +2 +3)]
+(documentation: /.^stream&
+ (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 [(^stream& x y z _tail) (some_stream_func +1 +2 +3)]
(func x y z))])
(.def: .public documentation
(.List $.Module)
($.module /._
""
- [..Sequence
+ [..Stream
..iterations
..repeated
..cycle
@@ -63,7 +62,7 @@
..only
..partition
- ..^sequence&
+ ..^stream&
($.default /.head)
($.default /.tail)
($.default /.functor)