diff options
Diffstat (limited to 'docs/collections_doc.md')
| -rwxr-xr-x | docs/collections_doc.md | 117 |
1 files changed, 42 insertions, 75 deletions
diff --git a/docs/collections_doc.md b/docs/collections_doc.md index 64ffb5e..1138850 100755 --- a/docs/collections_doc.md +++ b/docs/collections_doc.md @@ -1,3 +1,9 @@ +<!-- Generated with Stardoc: http://skydoc.bazel.build --> + +Skylib module containing functions that operate on collections. + +<a id="#collections.after_each"></a> + ## collections.after_each <pre> @@ -6,35 +12,20 @@ collections.after_each(<a href="#collections.after_each-separator">separator</a> Inserts `separator` after each item in `iterable`. -### Parameters - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="collections.after_each-separator"> - <td><code>separator</code></td> - <td> - required. - <p> - The value to insert after each item in `iterable`. - </p> - </td> - </tr> - <tr id="collections.after_each-iterable"> - <td><code>iterable</code></td> - <td> - required. - <p> - The list into which to intersperse the separator. - </p> - </td> - </tr> - </tbody> -</table> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="collections.after_each-separator"></a>separator | The value to insert after each item in <code>iterable</code>. | none | +| <a id="collections.after_each-iterable"></a>iterable | The list into which to intersperse the separator. | none | +**RETURNS** + +A new list with `separator` after each item in `iterable`. + + +<a id="#collections.before_each"></a> ## collections.before_each @@ -44,35 +35,20 @@ collections.before_each(<a href="#collections.before_each-separator">separator</ Inserts `separator` before each item in `iterable`. -### Parameters - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="collections.before_each-separator"> - <td><code>separator</code></td> - <td> - required. - <p> - The value to insert before each item in `iterable`. - </p> - </td> - </tr> - <tr id="collections.before_each-iterable"> - <td><code>iterable</code></td> - <td> - required. - <p> - The list into which to intersperse the separator. - </p> - </td> - </tr> - </tbody> -</table> +**PARAMETERS** + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="collections.before_each-separator"></a>separator | The value to insert before each item in <code>iterable</code>. | none | +| <a id="collections.before_each-iterable"></a>iterable | The list into which to intersperse the separator. | none | + +**RETURNS** + +A new list with `separator` before each item in `iterable`. + + +<a id="#collections.uniq"></a> ## collections.uniq @@ -85,24 +61,15 @@ Returns a list of unique elements in `iterable`. Requires all the elements to be hashable. -### Parameters - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="collections.uniq-iterable"> - <td><code>iterable</code></td> - <td> - required. - <p> - An iterable to filter. - </p> - </td> - </tr> - </tbody> -</table> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="collections.uniq-iterable"></a>iterable | An iterable to filter. | none | + +**RETURNS** + +A new list with all unique elements from `iterable`. |