diff options
author | Eduardo Julian | 2021-08-29 18:30:29 -0400 |
---|---|---|
committer | Eduardo Julian | 2021-08-29 18:30:29 -0400 |
commit | ff537895fe9c24f37a0ce11b640af5d4882571a5 (patch) | |
tree | f59778fa4163277d3ca3a1df450af82a401debb3 /stdlib/source/documentation/lux/data | |
parent | 1680d4d8bc4046ed4728413f1e7cfd77aa7e84b7 (diff) |
Better parameterized type documentation.
Diffstat (limited to 'stdlib/source/documentation/lux/data')
18 files changed, 19 insertions, 19 deletions
diff --git a/stdlib/source/documentation/lux/data/collection/array.lux b/stdlib/source/documentation/lux/data/collection/array.lux index 504d646cc..d9657e747 100644 --- a/stdlib/source/documentation/lux/data/collection/array.lux +++ b/stdlib/source/documentation/lux/data/collection/array.lux @@ -15,7 +15,7 @@ [\\library ["." /]]) -(documentation: /.Array +(documentation: (/.Array it) "Mutable arrays.") (documentation: /.empty diff --git a/stdlib/source/documentation/lux/data/collection/dictionary.lux b/stdlib/source/documentation/lux/data/collection/dictionary.lux index 95d2f998a..d1a0689ea 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary.lux @@ -18,7 +18,7 @@ ["#." ordered] ["#." plist]]) -(documentation: /.Dictionary +(documentation: (/.Dictionary key value) "A dictionary implemented as a Hash-Array Mapped Trie (HAMT).") (documentation: /.empty diff --git a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux index adbb1303f..755701934 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux @@ -15,7 +15,7 @@ [\\library ["." /]]) -(documentation: /.Dictionary +(documentation: (/.Dictionary key value) "A dictionary data-structure with ordered entries.") (documentation: /.empty diff --git a/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux b/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux index 2450cc9eb..a6fd8e4e9 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux @@ -15,7 +15,7 @@ [\\library ["." /]]) -(documentation: /.PList +(documentation: (/.PList it) (format "A property list." \n "It's a simple dictionary-like structure with Text keys.")) diff --git a/stdlib/source/documentation/lux/data/collection/queue.lux b/stdlib/source/documentation/lux/data/collection/queue.lux index 5b866fe90..d92371dc3 100644 --- a/stdlib/source/documentation/lux/data/collection/queue.lux +++ b/stdlib/source/documentation/lux/data/collection/queue.lux @@ -17,7 +17,7 @@ ["." / #_ ["#." priority]]) -(documentation: /.Queue +(documentation: (/.Queue it) "A first-in, first-out sequential data-structure.") (documentation: /.of_list diff --git a/stdlib/source/documentation/lux/data/collection/queue/priority.lux b/stdlib/source/documentation/lux/data/collection/queue/priority.lux index e62869ecd..96159b955 100644 --- a/stdlib/source/documentation/lux/data/collection/queue/priority.lux +++ b/stdlib/source/documentation/lux/data/collection/queue/priority.lux @@ -32,7 +32,7 @@ ($.default /.Priority) ($.default /.max) ($.default /.min) - ($.default /.Queue) + ($.default (/.Queue it)) ($.default /.empty) ($.default /.front) ($.default /.size) diff --git a/stdlib/source/documentation/lux/data/collection/row.lux b/stdlib/source/documentation/lux/data/collection/row.lux index a49b12bd4..25c174793 100644 --- a/stdlib/source/documentation/lux/data/collection/row.lux +++ b/stdlib/source/documentation/lux/data/collection/row.lux @@ -15,7 +15,7 @@ [\\library ["." /]]) -(documentation: /.Row +(documentation: (/.Row it) "A sequential data-structure with fast random access.") (documentation: /.suffix diff --git a/stdlib/source/documentation/lux/data/collection/sequence.lux b/stdlib/source/documentation/lux/data/collection/sequence.lux index 64e976155..6caac570d 100644 --- a/stdlib/source/documentation/lux/data/collection/sequence.lux +++ b/stdlib/source/documentation/lux/data/collection/sequence.lux @@ -15,7 +15,7 @@ [\\library ["." /]]) -(documentation: /.Sequence +(documentation: (/.Sequence it) "An infinite sequence of values.") (documentation: /.iterations diff --git a/stdlib/source/documentation/lux/data/collection/set.lux b/stdlib/source/documentation/lux/data/collection/set.lux index 2778305ec..7c92d4fef 100644 --- a/stdlib/source/documentation/lux/data/collection/set.lux +++ b/stdlib/source/documentation/lux/data/collection/set.lux @@ -45,7 +45,7 @@ ..intersection ..sub? ..super? - ($.default /.Set) + ($.default (/.Set it)) ($.default /.member_hash) ($.default /.empty) ($.default /.size) diff --git a/stdlib/source/documentation/lux/data/collection/set/multi.lux b/stdlib/source/documentation/lux/data/collection/set/multi.lux index 6e38886dc..5ddc82939 100644 --- a/stdlib/source/documentation/lux/data/collection/set/multi.lux +++ b/stdlib/source/documentation/lux/data/collection/set/multi.lux @@ -13,7 +13,7 @@ [\\library ["." /]]) -(documentation: /.Set +(documentation: (/.Set it) "A set that keeps track of repetition in its entries.") (documentation: /.has diff --git a/stdlib/source/documentation/lux/data/collection/set/ordered.lux b/stdlib/source/documentation/lux/data/collection/set/ordered.lux index 0ace59c12..8f9c90c1c 100644 --- a/stdlib/source/documentation/lux/data/collection/set/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/set/ordered.lux @@ -13,7 +13,7 @@ [\\library ["." /]]) -(documentation: /.Set +(documentation: (/.Set it) "A set with ordered entries.") (documentation: /.member? diff --git a/stdlib/source/documentation/lux/data/collection/stack.lux b/stdlib/source/documentation/lux/data/collection/stack.lux index c020db741..557564f92 100644 --- a/stdlib/source/documentation/lux/data/collection/stack.lux +++ b/stdlib/source/documentation/lux/data/collection/stack.lux @@ -13,7 +13,7 @@ [\\library ["." /]]) -(documentation: /.Stack +(documentation: (/.Stack it) "A first-in, last-out sequential data-structure.") (documentation: /.value diff --git a/stdlib/source/documentation/lux/data/collection/tree.lux b/stdlib/source/documentation/lux/data/collection/tree.lux index 310073287..ed6161796 100644 --- a/stdlib/source/documentation/lux/data/collection/tree.lux +++ b/stdlib/source/documentation/lux/data/collection/tree.lux @@ -16,7 +16,7 @@ ["#." finger] ["#." zipper]]) -(documentation: /.Tree +(documentation: (/.Tree it) "A generic tree data-structure.") (documentation: /.flat diff --git a/stdlib/source/documentation/lux/data/collection/tree/finger.lux b/stdlib/source/documentation/lux/data/collection/tree/finger.lux index 683d98f51..0f47d78f5 100644 --- a/stdlib/source/documentation/lux/data/collection/tree/finger.lux +++ b/stdlib/source/documentation/lux/data/collection/tree/finger.lux @@ -13,10 +13,10 @@ [\\library ["." /]]) -(documentation: /.Tree +(documentation: (/.Tree @ tag value) "A finger tree.") -(documentation: /.Builder +(documentation: (/.Builder @ tag) "A builder for finter tree structures.") (documentation: /.builder diff --git a/stdlib/source/documentation/lux/data/collection/tree/zipper.lux b/stdlib/source/documentation/lux/data/collection/tree/zipper.lux index d67fb37bf..7f72d669e 100644 --- a/stdlib/source/documentation/lux/data/collection/tree/zipper.lux +++ b/stdlib/source/documentation/lux/data/collection/tree/zipper.lux @@ -13,7 +13,7 @@ [\\library ["." /]]) -(documentation: /.Zipper +(documentation: (/.Zipper it) "Tree zippers, for easy navigation and editing of trees.") (documentation: /.set diff --git a/stdlib/source/documentation/lux/data/format/binary.lux b/stdlib/source/documentation/lux/data/format/binary.lux index 229f262b0..42a6c924b 100644 --- a/stdlib/source/documentation/lux/data/format/binary.lux +++ b/stdlib/source/documentation/lux/data/format/binary.lux @@ -22,7 +22,7 @@ (documentation: /.instance "Given a specification of how to construct binary data, yields a binary blob that matches it.") -(documentation: /.Writer +(documentation: (/.Writer it) "An operation that knows how to write information into a binary blob.") (documentation: /.result diff --git a/stdlib/source/documentation/lux/data/identity.lux b/stdlib/source/documentation/lux/data/identity.lux index b67f8470b..95aef4075 100644 --- a/stdlib/source/documentation/lux/data/identity.lux +++ b/stdlib/source/documentation/lux/data/identity.lux @@ -10,7 +10,7 @@ [\\library ["." /]]) -(documentation: /.Identity +(documentation: (/.Identity it) "A value, as is, without any extra structure super-imposed on it.") (.def: .public documentation diff --git a/stdlib/source/documentation/lux/data/text/format.lux b/stdlib/source/documentation/lux/data/text/format.lux index 4f823901e..046682386 100644 --- a/stdlib/source/documentation/lux/data/text/format.lux +++ b/stdlib/source/documentation/lux/data/text/format.lux @@ -7,7 +7,7 @@ [\\library ["." /]]) -(documentation: /.Format +(documentation: (/.Format it) "A way to produce readable text from values.") (documentation: /.format |