create a manual documentation-regenerator script and apply it
This commit is contained in:
Chris Parsons
parent
9cedee3938
commit
6813a397a8
|
|
@ -12,7 +12,7 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
|
||||||
git_repository(
|
git_repository(
|
||||||
name = "io_bazel_skydoc",
|
name = "io_bazel_skydoc",
|
||||||
remote = "https://github.com/bazelbuild/skydoc.git",
|
remote = "https://github.com/bazelbuild/skydoc.git",
|
||||||
tag = "0.2.0",
|
commit = "ac5c106412697ffb9364864070bac796b9bb63d3",
|
||||||
)
|
)
|
||||||
load("@io_bazel_skydoc//skylark:skylark.bzl", "skydoc_repositories")
|
load("@io_bazel_skydoc//skylark:skylark.bzl", "skydoc_repositories")
|
||||||
skydoc_repositories()
|
skydoc_repositories()
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,4 @@
|
||||||
load("@io_bazel_skydoc//stardoc:stardoc.bzl",
|
load("@io_bazel_skydoc//stardoc:stardoc.bzl", "stardoc")
|
||||||
"stardoc")
|
|
||||||
|
|
||||||
# Note that due to a bug in Bazel 0.22.0, these targets cannot be built without
|
# Note that due to a bug in Bazel 0.22.0, these targets cannot be built without
|
||||||
# the --experimental_remap_main_repo flag.
|
# the --experimental_remap_main_repo flag.
|
||||||
|
|
|
||||||
|
|
@ -60,29 +60,3 @@ Test rule checking that other targets can be successfully analyzed.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _analysis_test_impl
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_analysis_test_impl(<a href="#_analysis_test_impl-ctx">ctx</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Implementation function for analysis_test.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_analysis_test_impl-ctx>
|
|
||||||
<td><code>ctx</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ Typical usage:
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="build_test-name>
|
<tr id="build_test-name">
|
||||||
<td><code>name</code></td>
|
<td><code>name</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -41,7 +41,7 @@ Typical usage:
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="build_test-targets>
|
<tr id="build_test-targets">
|
||||||
<td><code>targets</code></td>
|
<td><code>targets</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -50,10 +50,13 @@ Typical usage:
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="build_test-kwargs>
|
<tr id="build_test-kwargs">
|
||||||
<td><code>kwargs</code></td>
|
<td><code>kwargs</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
optional.
|
||||||
|
<p>
|
||||||
|
The <a href="https://docs.bazel.build/versions/master/be/common-definitions.html#common-attributes-tests">common attributes for tests</a>.
|
||||||
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
## _after_each
|
## collections.after_each
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_after_each(<a href="#_after_each-separator">separator</a>, <a href="#_after_each-iterable">iterable</a>)
|
collections.after_each(<a href="#collections.after_each-separator">separator</a>, <a href="#collections.after_each-iterable">iterable</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Inserts `separator` after each item in `iterable`.
|
Inserts `separator` after each item in `iterable`.
|
||||||
|
|
@ -14,7 +14,7 @@ Inserts `separator` after each item in `iterable`.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_after_each-separator>
|
<tr id="collections.after_each-separator">
|
||||||
<td><code>separator</code></td>
|
<td><code>separator</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -23,7 +23,7 @@ Inserts `separator` after each item in `iterable`.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_after_each-iterable>
|
<tr id="collections.after_each-iterable">
|
||||||
<td><code>iterable</code></td>
|
<td><code>iterable</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -36,10 +36,10 @@ Inserts `separator` after each item in `iterable`.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _before_each
|
## collections.before_each
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_before_each(<a href="#_before_each-separator">separator</a>, <a href="#_before_each-iterable">iterable</a>)
|
collections.before_each(<a href="#collections.before_each-separator">separator</a>, <a href="#collections.before_each-iterable">iterable</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Inserts `separator` before each item in `iterable`.
|
Inserts `separator` before each item in `iterable`.
|
||||||
|
|
@ -52,7 +52,7 @@ Inserts `separator` before each item in `iterable`.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_before_each-separator>
|
<tr id="collections.before_each-separator">
|
||||||
<td><code>separator</code></td>
|
<td><code>separator</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -61,7 +61,7 @@ Inserts `separator` before each item in `iterable`.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_before_each-iterable>
|
<tr id="collections.before_each-iterable">
|
||||||
<td><code>iterable</code></td>
|
<td><code>iterable</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -74,10 +74,10 @@ Inserts `separator` before each item in `iterable`.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _uniq
|
## collections.uniq
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_uniq(<a href="#_uniq-iterable">iterable</a>)
|
collections.uniq(<a href="#collections.uniq-iterable">iterable</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns a list of unique elements in `iterable`.
|
Returns a list of unique elements in `iterable`.
|
||||||
|
|
@ -93,7 +93,7 @@ Requires all the elements to be hashable.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_uniq-iterable>
|
<tr id="collections.uniq-iterable">
|
||||||
<td><code>iterable</code></td>
|
<td><code>iterable</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
## _add
|
## dicts.add
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_add(<a href="#_add-dictionaries">dictionaries</a>)
|
dicts.add(<a href="#dicts.add-dictionaries">dictionaries</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns a new `dict` that has all the entries of the given dictionaries.
|
Returns a new `dict` that has all the entries of the given dictionaries.
|
||||||
|
|
@ -23,10 +23,13 @@ dictionary, and the sum of a single dictionary is a copy of itself.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_add-dictionaries>
|
<tr id="dicts.add-dictionaries">
|
||||||
<td><code>dictionaries</code></td>
|
<td><code>dictionaries</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
optional.
|
||||||
|
<p>
|
||||||
|
Zero or more dictionaries to be added.
|
||||||
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -1,375 +1,7 @@
|
||||||
## _contains
|
## sets.make
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_contains(<a href="#_contains-a">a</a>, <a href="#_contains-e">e</a>)
|
sets.make(<a href="#sets.make-elements">elements</a>)
|
||||||
</pre>
|
|
||||||
|
|
||||||
Checks for the existence of an element in a set.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_contains-a>
|
|
||||||
<td><code>a</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_contains-e>
|
|
||||||
<td><code>e</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The element to look for.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _copy
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_copy(<a href="#_copy-s">s</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Creates a new set from another set.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_copy-s>
|
|
||||||
<td><code>s</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _difference
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_difference(<a href="#_difference-a">a</a>, <a href="#_difference-b">b</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns the elements in `a` that are not in `b`.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_difference-a>
|
|
||||||
<td><code>a</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_difference-b>
|
|
||||||
<td><code>b</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _disjoint
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_disjoint(<a href="#_disjoint-a">a</a>, <a href="#_disjoint-b">b</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns whether two sets are disjoint.
|
|
||||||
|
|
||||||
Two sets are disjoint if they have no elements in common.
|
|
||||||
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_disjoint-a>
|
|
||||||
<td><code>a</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_disjoint-b>
|
|
||||||
<td><code>b</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _get_shorter_and_longer
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_get_shorter_and_longer(<a href="#_get_shorter_and_longer-a">a</a>, <a href="#_get_shorter_and_longer-b">b</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns two sets in the order of shortest and longest.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_get_shorter_and_longer-a>
|
|
||||||
<td><code>a</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_get_shorter_and_longer-b>
|
|
||||||
<td><code>b</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _insert
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_insert(<a href="#_insert-s">s</a>, <a href="#_insert-e">e</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Inserts an element into the set.
|
|
||||||
|
|
||||||
Element must be hashable. This mutates the orginal set.
|
|
||||||
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_insert-s>
|
|
||||||
<td><code>s</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_insert-e>
|
|
||||||
<td><code>e</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The element to be inserted.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _intersection
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_intersection(<a href="#_intersection-a">a</a>, <a href="#_intersection-b">b</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns the intersection of two sets.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_intersection-a>
|
|
||||||
<td><code>a</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_intersection-b>
|
|
||||||
<td><code>b</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_equal
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_equal(<a href="#_is_equal-a">a</a>, <a href="#_is_equal-b">b</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns whether two sets are equal.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_equal-a>
|
|
||||||
<td><code>a</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_is_equal-b>
|
|
||||||
<td><code>b</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_subset
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_subset(<a href="#_is_subset-a">a</a>, <a href="#_is_subset-b">b</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns whether `a` is a subset of `b`.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_subset-a>
|
|
||||||
<td><code>a</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_is_subset-b>
|
|
||||||
<td><code>b</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _length
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_length(<a href="#_length-s">s</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns the number of elements in a set.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_length-s>
|
|
||||||
<td><code>s</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
A set, as returned by `sets.make()`.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _make
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_make(<a href="#_make-elements">elements</a>)
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Creates a new set.
|
Creates a new set.
|
||||||
|
|
@ -385,7 +17,7 @@ All elements must be hashable.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_make-elements>
|
<tr id="sets.make-elements">
|
||||||
<td><code>elements</code></td>
|
<td><code>elements</code></td>
|
||||||
<td>
|
<td>
|
||||||
optional. default is <code>None</code>
|
optional. default is <code>None</code>
|
||||||
|
|
@ -398,10 +30,398 @@ All elements must be hashable.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _remove
|
## sets.copy
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_remove(<a href="#_remove-s">s</a>, <a href="#_remove-e">e</a>)
|
sets.copy(<a href="#sets.copy-s">s</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Creates a new set from another set.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.copy-s">
|
||||||
|
<td><code>s</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.to_list
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.to_list(<a href="#sets.to_list-s">s</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Creates a list from the values in the set.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.to_list-s">
|
||||||
|
<td><code>s</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.insert
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.insert(<a href="#sets.insert-s">s</a>, <a href="#sets.insert-e">e</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Inserts an element into the set.
|
||||||
|
|
||||||
|
Element must be hashable. This mutates the orginal set.
|
||||||
|
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.insert-s">
|
||||||
|
<td><code>s</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="sets.insert-e">
|
||||||
|
<td><code>e</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The element to be inserted.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.contains
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.contains(<a href="#sets.contains-a">a</a>, <a href="#sets.contains-e">e</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Checks for the existence of an element in a set.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.contains-a">
|
||||||
|
<td><code>a</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="sets.contains-e">
|
||||||
|
<td><code>e</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The element to look for.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.is_equal
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.is_equal(<a href="#sets.is_equal-a">a</a>, <a href="#sets.is_equal-b">b</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns whether two sets are equal.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.is_equal-a">
|
||||||
|
<td><code>a</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="sets.is_equal-b">
|
||||||
|
<td><code>b</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.is_subset
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.is_subset(<a href="#sets.is_subset-a">a</a>, <a href="#sets.is_subset-b">b</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns whether `a` is a subset of `b`.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.is_subset-a">
|
||||||
|
<td><code>a</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="sets.is_subset-b">
|
||||||
|
<td><code>b</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.disjoint
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.disjoint(<a href="#sets.disjoint-a">a</a>, <a href="#sets.disjoint-b">b</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns whether two sets are disjoint.
|
||||||
|
|
||||||
|
Two sets are disjoint if they have no elements in common.
|
||||||
|
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.disjoint-a">
|
||||||
|
<td><code>a</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="sets.disjoint-b">
|
||||||
|
<td><code>b</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.intersection
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.intersection(<a href="#sets.intersection-a">a</a>, <a href="#sets.intersection-b">b</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns the intersection of two sets.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.intersection-a">
|
||||||
|
<td><code>a</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="sets.intersection-b">
|
||||||
|
<td><code>b</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.union
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.union(<a href="#sets.union-args">args</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns the union of several sets.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.union-args">
|
||||||
|
<td><code>args</code></td>
|
||||||
|
<td>
|
||||||
|
optional.
|
||||||
|
<p>
|
||||||
|
An arbitrary number of sets or lists.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.difference
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.difference(<a href="#sets.difference-a">a</a>, <a href="#sets.difference-b">b</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns the elements in `a` that are not in `b`.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.difference-a">
|
||||||
|
<td><code>a</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="sets.difference-b">
|
||||||
|
<td><code>b</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.length
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.length(<a href="#sets.length-s">s</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns the number of elements in a set.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="sets.length-s">
|
||||||
|
<td><code>s</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
A set, as returned by `sets.make()`.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## sets.remove
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
sets.remove(<a href="#sets.remove-s">s</a>, <a href="#sets.remove-e">e</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Removes an element from the set.
|
Removes an element from the set.
|
||||||
|
|
@ -417,7 +437,7 @@ Element must be hashable. This mutates the orginal set.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_remove-s>
|
<tr id="sets.remove-s">
|
||||||
<td><code>s</code></td>
|
<td><code>s</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -426,7 +446,7 @@ Element must be hashable. This mutates the orginal set.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_remove-e>
|
<tr id="sets.remove-e">
|
||||||
<td><code>e</code></td>
|
<td><code>e</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -439,10 +459,10 @@ Element must be hashable. This mutates the orginal set.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _repr
|
## sets.repr
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_repr(<a href="#_repr-s">s</a>)
|
sets.repr(<a href="#sets.repr-s">s</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns a string value representing the set.
|
Returns a string value representing the set.
|
||||||
|
|
@ -455,7 +475,7 @@ Returns a string value representing the set.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_repr-s>
|
<tr id="sets.repr-s">
|
||||||
<td><code>s</code></td>
|
<td><code>s</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -468,13 +488,13 @@ Returns a string value representing the set.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _to_list
|
## sets.str
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_to_list(<a href="#_to_list-s">s</a>)
|
sets.str(<a href="#sets.str-s">s</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Creates a list from the values in the set.
|
Returns a string value representing the set.
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
|
|
@ -484,7 +504,7 @@ Creates a list from the values in the set.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_to_list-s>
|
<tr id="sets.str-s">
|
||||||
<td><code>s</code></td>
|
<td><code>s</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -497,29 +517,3 @@ Creates a list from the values in the set.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _union
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_union(<a href="#_union-args">args</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns the union of several sets.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_union-args>
|
|
||||||
<td><code>args</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,48 +1,7 @@
|
||||||
## _call
|
## partial.make
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_call(<a href="#_call-partial">partial</a>, <a href="#_call-args">args</a>, <a href="#_call-kwargs">kwargs</a>)
|
partial.make(<a href="#partial.make-func">func</a>, <a href="#partial.make-args">args</a>, <a href="#partial.make-kwargs">kwargs</a>)
|
||||||
</pre>
|
|
||||||
|
|
||||||
Calls a partial created using `make`.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_call-partial>
|
|
||||||
<td><code>partial</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The partial to be called.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_call-args>
|
|
||||||
<td><code>args</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_call-kwargs>
|
|
||||||
<td><code>kwargs</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _make
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_make(<a href="#_make-func">func</a>, <a href="#_make-args">args</a>, <a href="#_make-kwargs">kwargs</a>)
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Creates a partial that can be called using `call`.
|
Creates a partial that can be called using `call`.
|
||||||
|
|
@ -129,7 +88,7 @@ partial.call(func, x=2)
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_make-func>
|
<tr id="partial.make-func">
|
||||||
<td><code>func</code></td>
|
<td><code>func</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -138,16 +97,72 @@ partial.call(func, x=2)
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_make-args>
|
<tr id="partial.make-args">
|
||||||
<td><code>args</code></td>
|
<td><code>args</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
optional.
|
||||||
|
<p>
|
||||||
|
Positional arguments to be passed to function.
|
||||||
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_make-kwargs>
|
<tr id="partial.make-kwargs">
|
||||||
<td><code>kwargs</code></td>
|
<td><code>kwargs</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
optional.
|
||||||
|
<p>
|
||||||
|
Keyword arguments to be passed to function. Note that these can
|
||||||
|
be overridden at the call sites.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## partial.call
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
partial.call(<a href="#partial.call-partial">partial</a>, <a href="#partial.call-args">args</a>, <a href="#partial.call-kwargs">kwargs</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Calls a partial created using `make`.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="partial.call-partial">
|
||||||
|
<td><code>partial</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The partial to be called.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="partial.call-args">
|
||||||
|
<td><code>args</code></td>
|
||||||
|
<td>
|
||||||
|
optional.
|
||||||
|
<p>
|
||||||
|
Additional positional arguments to be appended to the ones given to
|
||||||
|
make.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="partial.call-kwargs">
|
||||||
|
<td><code>kwargs</code></td>
|
||||||
|
<td>
|
||||||
|
optional.
|
||||||
|
<p>
|
||||||
|
Additional keyword arguments to augment and override the ones
|
||||||
|
given to make.
|
||||||
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
## _basename
|
## paths.basename
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_basename(<a href="#_basename-p">p</a>)
|
paths.basename(<a href="#paths.basename-p">p</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns the basename (i.e., the file portion) of a path.
|
Returns the basename (i.e., the file portion) of a path.
|
||||||
|
|
@ -20,7 +20,7 @@ the final slash).
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_basename-p>
|
<tr id="paths.basename-p">
|
||||||
<td><code>p</code></td>
|
<td><code>p</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -33,10 +33,10 @@ the final slash).
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _dirname
|
## paths.dirname
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_dirname(<a href="#_dirname-p">p</a>)
|
paths.dirname(<a href="#paths.dirname-p">p</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns the dirname of a path.
|
Returns the dirname of a path.
|
||||||
|
|
@ -54,7 +54,7 @@ included, unless omitting them would make the dirname empty.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_dirname-p>
|
<tr id="paths.dirname-p">
|
||||||
<td><code>p</code></td>
|
<td><code>p</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -67,10 +67,10 @@ included, unless omitting them would make the dirname empty.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _is_absolute
|
## paths.is_absolute
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_is_absolute(<a href="#_is_absolute-path">path</a>)
|
paths.is_absolute(<a href="#paths.is_absolute-path">path</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns `True` if `path` is an absolute path.
|
Returns `True` if `path` is an absolute path.
|
||||||
|
|
@ -83,7 +83,7 @@ Returns `True` if `path` is an absolute path.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_is_absolute-path>
|
<tr id="paths.is_absolute-path">
|
||||||
<td><code>path</code></td>
|
<td><code>path</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -96,10 +96,10 @@ Returns `True` if `path` is an absolute path.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _join
|
## paths.join
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_join(<a href="#_join-path">path</a>, <a href="#_join-others">others</a>)
|
paths.join(<a href="#paths.join-path">path</a>, <a href="#paths.join-others">others</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Joins one or more path components intelligently.
|
Joins one or more path components intelligently.
|
||||||
|
|
@ -121,7 +121,7 @@ If any component is an absolute path, all previous components are discarded.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_join-path>
|
<tr id="paths.join-path">
|
||||||
<td><code>path</code></td>
|
<td><code>path</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -130,20 +130,23 @@ If any component is an absolute path, all previous components are discarded.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_join-others>
|
<tr id="paths.join-others">
|
||||||
<td><code>others</code></td>
|
<td><code>others</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
optional.
|
||||||
|
<p>
|
||||||
|
Additional path segments.
|
||||||
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _normalize
|
## paths.normalize
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_normalize(<a href="#_normalize-path">path</a>)
|
paths.normalize(<a href="#paths.normalize-path">path</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Normalizes a path, eliminating double slashes and other redundant segments.
|
Normalizes a path, eliminating double slashes and other redundant segments.
|
||||||
|
|
@ -171,7 +174,7 @@ POSIX platforms; specifically:
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_normalize-path>
|
<tr id="paths.normalize-path">
|
||||||
<td><code>path</code></td>
|
<td><code>path</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -184,10 +187,10 @@ POSIX platforms; specifically:
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _relativize
|
## paths.relativize
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_relativize(<a href="#_relativize-path">path</a>, <a href="#_relativize-start">start</a>)
|
paths.relativize(<a href="#paths.relativize-path">path</a>, <a href="#paths.relativize-start">start</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns the portion of `path` that is relative to `start`.
|
Returns the portion of `path` that is relative to `start`.
|
||||||
|
|
@ -209,7 +212,7 @@ the path both start with the same initial parent references.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_relativize-path>
|
<tr id="paths.relativize-path">
|
||||||
<td><code>path</code></td>
|
<td><code>path</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -218,7 +221,7 @@ the path both start with the same initial parent references.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_relativize-start>
|
<tr id="paths.relativize-start">
|
||||||
<td><code>start</code></td>
|
<td><code>start</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -231,10 +234,10 @@ the path both start with the same initial parent references.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _replace_extension
|
## paths.replace_extension
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_replace_extension(<a href="#_replace_extension-p">p</a>, <a href="#_replace_extension-new_extension">new_extension</a>)
|
paths.replace_extension(<a href="#paths.replace_extension-p">p</a>, <a href="#paths.replace_extension-new_extension">new_extension</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Replaces the extension of the file at the end of a path.
|
Replaces the extension of the file at the end of a path.
|
||||||
|
|
@ -250,7 +253,7 @@ If the path has no extension, the new extension is added to it.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_replace_extension-p>
|
<tr id="paths.replace_extension-p">
|
||||||
<td><code>p</code></td>
|
<td><code>p</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -259,7 +262,7 @@ If the path has no extension, the new extension is added to it.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_replace_extension-new_extension>
|
<tr id="paths.replace_extension-new_extension">
|
||||||
<td><code>new_extension</code></td>
|
<td><code>new_extension</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -273,10 +276,10 @@ If the path has no extension, the new extension is added to it.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _split_extension
|
## paths.split_extension
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_split_extension(<a href="#_split_extension-p">p</a>)
|
paths.split_extension(<a href="#paths.split_extension-p">p</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Splits the path `p` into a tuple containing the root and extension.
|
Splits the path `p` into a tuple containing the root and extension.
|
||||||
|
|
@ -293,7 +296,7 @@ Leading periods on the basename are ignored, so
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_split_extension-p>
|
<tr id="paths.split_extension-p">
|
||||||
<td><code>p</code></td>
|
<td><code>p</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Copyright 2019 The Bazel Authors. All rights reserved.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# A script to manually regenerate the documentation contained in the docs/ directory.
|
||||||
|
# Should be run from the WORKSPACE root.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
bazel build docs:all --experimental_remap_main_repo
|
||||||
|
|
||||||
|
for filename in bazel-bin/docs/*_gen.md; do
|
||||||
|
target_filename="$(echo $filename | sed -En "s/bazel-bin\/(.*)_gen.md/\1/p").md"
|
||||||
|
cp $filename $target_filename
|
||||||
|
done
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
## _with_or
|
## selects.with_or
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_with_or(<a href="#_with_or-input_dict">input_dict</a>, <a href="#_with_or-no_match_error">no_match_error</a>)
|
selects.with_or(<a href="#selects.with_or-input_dict">input_dict</a>, <a href="#selects.with_or-no_match_error">no_match_error</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Drop-in replacement for `select()` that supports ORed keys.
|
Drop-in replacement for `select()` that supports ORed keys.
|
||||||
|
|
@ -14,7 +14,7 @@ Drop-in replacement for `select()` that supports ORed keys.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_with_or-input_dict>
|
<tr id="selects.with_or-input_dict">
|
||||||
<td><code>input_dict</code></td>
|
<td><code>input_dict</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -26,7 +26,7 @@ Drop-in replacement for `select()` that supports ORed keys.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="_with_or-no_match_error>
|
<tr id="selects.with_or-no_match_error">
|
||||||
<td><code>no_match_error</code></td>
|
<td><code>no_match_error</code></td>
|
||||||
<td>
|
<td>
|
||||||
optional. default is <code>""</code>
|
optional. default is <code>""</code>
|
||||||
|
|
@ -52,10 +52,10 @@ Drop-in replacement for `select()` that supports ORed keys.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _with_or_dict
|
## selects.with_or_dict
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_with_or_dict(<a href="#_with_or_dict-input_dict">input_dict</a>)
|
selects.with_or_dict(<a href="#selects.with_or_dict-input_dict">input_dict</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Variation of `with_or` that returns the dict of the `select()`.
|
Variation of `with_or` that returns the dict of the `select()`.
|
||||||
|
|
@ -72,7 +72,7 @@ macros.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_with_or_dict-input_dict>
|
<tr id="selects.with_or_dict-input_dict">
|
||||||
<td><code>input_dict</code></td>
|
<td><code>input_dict</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
## _array_literal
|
## shell.array_literal
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_array_literal(<a href="#_array_literal-iterable">iterable</a>)
|
shell.array_literal(<a href="#shell.array_literal-iterable">iterable</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Creates a string from a sequence that can be used as a shell array.
|
Creates a string from a sequence that can be used as a shell array.
|
||||||
|
|
@ -22,7 +22,7 @@ safety, even if they do not need to be.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_array_literal-iterable>
|
<tr id="shell.array_literal-iterable">
|
||||||
<td><code>iterable</code></td>
|
<td><code>iterable</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -36,10 +36,10 @@ safety, even if they do not need to be.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _quote
|
## shell.quote
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_quote(<a href="#_quote-s">s</a>)
|
shell.quote(<a href="#shell.quote-s">s</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Quotes the given string for use in a shell command.
|
Quotes the given string for use in a shell command.
|
||||||
|
|
@ -56,7 +56,7 @@ shell metacharacters.)
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_quote-s>
|
<tr id="shell.quote-s">
|
||||||
<td><code>s</code></td>
|
<td><code>s</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
## _to_dict
|
## structs.to_dict
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_to_dict(<a href="#_to_dict-s">s</a>)
|
structs.to_dict(<a href="#structs.to_dict-s">s</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Converts a `struct` to a `dict`.
|
Converts a `struct` to a `dict`.
|
||||||
|
|
@ -14,7 +14,7 @@ Converts a `struct` to a `dict`.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_to_dict-s>
|
<tr id="structs.to_dict-s">
|
||||||
<td><code>s</code></td>
|
<td><code>s</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
|
||||||
|
|
@ -1,162 +1,7 @@
|
||||||
## _a_function
|
## types.is_list
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_a_function()
|
types.is_list(<a href="#types.is_list-v">v</a>)
|
||||||
</pre>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _is_bool
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_bool(<a href="#_is_bool-v">v</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns True if v is an instance of a bool.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_bool-v>
|
|
||||||
<td><code>v</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The value whose type should be checked.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_depset
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_depset(<a href="#_is_depset-v">v</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns True if v is an instance of a `depset`.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_depset-v>
|
|
||||||
<td><code>v</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The value whose type should be checked.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_dict
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_dict(<a href="#_is_dict-v">v</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns True if v is an instance of a dict.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_dict-v>
|
|
||||||
<td><code>v</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The value whose type should be checked.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_function
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_function(<a href="#_is_function-v">v</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns True if v is an instance of a function.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_function-v>
|
|
||||||
<td><code>v</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The value whose type should be checked.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_int
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_int(<a href="#_is_int-v">v</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns True if v is an instance of a signed integer.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_int-v>
|
|
||||||
<td><code>v</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The value whose type should be checked.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_list
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_list(<a href="#_is_list-v">v</a>)
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns True if v is an instance of a list.
|
Returns True if v is an instance of a list.
|
||||||
|
|
@ -169,7 +14,7 @@ Returns True if v is an instance of a list.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_is_list-v>
|
<tr id="types.is_list-v">
|
||||||
<td><code>v</code></td>
|
<td><code>v</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -182,39 +27,10 @@ Returns True if v is an instance of a list.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _is_none
|
## types.is_string
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_is_none(<a href="#_is_none-v">v</a>)
|
types.is_string(<a href="#types.is_string-v">v</a>)
|
||||||
</pre>
|
|
||||||
|
|
||||||
Returns True if v has the type of None.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_none-v>
|
|
||||||
<td><code>v</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
The value whose type should be checked.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_string
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_string(<a href="#_is_string-v">v</a>)
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns True if v is an instance of a string.
|
Returns True if v is an instance of a string.
|
||||||
|
|
@ -227,7 +43,7 @@ Returns True if v is an instance of a string.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_is_string-v>
|
<tr id="types.is_string-v">
|
||||||
<td><code>v</code></td>
|
<td><code>v</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -240,10 +56,97 @@ Returns True if v is an instance of a string.
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
## _is_tuple
|
## types.is_bool
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_is_tuple(<a href="#_is_tuple-v">v</a>)
|
types.is_bool(<a href="#types.is_bool-v">v</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns True if v is an instance of a bool.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="types.is_bool-v">
|
||||||
|
<td><code>v</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The value whose type should be checked.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## types.is_none
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
types.is_none(<a href="#types.is_none-v">v</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns True if v has the type of None.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="types.is_none-v">
|
||||||
|
<td><code>v</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The value whose type should be checked.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## types.is_int
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
types.is_int(<a href="#types.is_int-v">v</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns True if v is an instance of a signed integer.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="types.is_int-v">
|
||||||
|
<td><code>v</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The value whose type should be checked.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## types.is_tuple
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
types.is_tuple(<a href="#types.is_tuple-v">v</a>)
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns True if v is an instance of a tuple.
|
Returns True if v is an instance of a tuple.
|
||||||
|
|
@ -256,7 +159,94 @@ Returns True if v is an instance of a tuple.
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_is_tuple-v>
|
<tr id="types.is_tuple-v">
|
||||||
|
<td><code>v</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The value whose type should be checked.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## types.is_dict
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
types.is_dict(<a href="#types.is_dict-v">v</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns True if v is an instance of a dict.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="types.is_dict-v">
|
||||||
|
<td><code>v</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The value whose type should be checked.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## types.is_function
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
types.is_function(<a href="#types.is_function-v">v</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns True if v is an instance of a function.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="types.is_function-v">
|
||||||
|
<td><code>v</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
The value whose type should be checked.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## types.is_depset
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
types.is_depset(<a href="#types.is_depset-v">v</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Returns True if v is an instance of a `depset`.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="types.is_depset-v">
|
||||||
<td><code>v</code></td>
|
<td><code>v</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
|
||||||
1349
docs/unittest_doc.md
1349
docs/unittest_doc.md
File diff suppressed because it is too large
Load Diff
|
|
@ -1,170 +1,17 @@
|
||||||
## _check_bazel_version
|
## versions.get
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_check_bazel_version(<a href="#_check_bazel_version-minimum_bazel_version">minimum_bazel_version</a>, <a href="#_check_bazel_version-maximum_bazel_version">maximum_bazel_version</a>, <a href="#_check_bazel_version-bazel_version">bazel_version</a>)
|
versions.get()
|
||||||
</pre>
|
|
||||||
|
|
||||||
Check that the version of Bazel is valid within the specified range.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_check_bazel_version-minimum_bazel_version>
|
|
||||||
<td><code>minimum_bazel_version</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
minimum version of Bazel expected
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_check_bazel_version-maximum_bazel_version>
|
|
||||||
<td><code>maximum_bazel_version</code></td>
|
|
||||||
<td>
|
|
||||||
optional. default is <code>None</code>
|
|
||||||
<p>
|
|
||||||
maximum version of Bazel expected
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_check_bazel_version-bazel_version>
|
|
||||||
<td><code>bazel_version</code></td>
|
|
||||||
<td>
|
|
||||||
optional. default is <code>None</code>
|
|
||||||
<p>
|
|
||||||
the version of Bazel to check. Used for testing, defaults to native.bazel_version
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _extract_version_number
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_extract_version_number(<a href="#_extract_version_number-bazel_version">bazel_version</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Extracts the semantic version number from a version string
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_extract_version_number-bazel_version>
|
|
||||||
<td><code>bazel_version</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
the version string that begins with the semantic version
|
|
||||||
e.g. "1.2.3rc1 abc1234" where "abc1234" is a commit hash.
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _get_bazel_version
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_get_bazel_version()
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Returns the current Bazel version
|
Returns the current Bazel version
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _is_at_least
|
## versions.parse
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
_is_at_least(<a href="#_is_at_least-threshold">threshold</a>, <a href="#_is_at_least-version">version</a>)
|
versions.parse(<a href="#versions.parse-bazel_version">bazel_version</a>)
|
||||||
</pre>
|
|
||||||
|
|
||||||
Check that a version is higher or equals to a threshold.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_at_least-threshold>
|
|
||||||
<td><code>threshold</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
the minimum version string
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_is_at_least-version>
|
|
||||||
<td><code>version</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
the version string to be compared to the threshold
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _is_at_most
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_is_at_most(<a href="#_is_at_most-threshold">threshold</a>, <a href="#_is_at_most-version">version</a>)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Check that a version is lower or equals to a threshold.
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
<table class="params-table">
|
|
||||||
<colgroup>
|
|
||||||
<col class="col-param" />
|
|
||||||
<col class="col-description" />
|
|
||||||
</colgroup>
|
|
||||||
<tbody>
|
|
||||||
<tr id="_is_at_most-threshold>
|
|
||||||
<td><code>threshold</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
the maximum version string
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr id="_is_at_most-version>
|
|
||||||
<td><code>version</code></td>
|
|
||||||
<td>
|
|
||||||
required.
|
|
||||||
<p>
|
|
||||||
the version string to be compared to the threshold
|
|
||||||
</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
## _parse_bazel_version
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
_parse_bazel_version(<a href="#_parse_bazel_version-bazel_version">bazel_version</a>)
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Parses a version string into a 3-tuple of ints
|
Parses a version string into a 3-tuple of ints
|
||||||
|
|
@ -180,7 +27,7 @@ int tuples can be compared directly using binary operators (<, >).
|
||||||
<col class="col-description" />
|
<col class="col-description" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr id="_parse_bazel_version-bazel_version>
|
<tr id="versions.parse-bazel_version">
|
||||||
<td><code>bazel_version</code></td>
|
<td><code>bazel_version</code></td>
|
||||||
<td>
|
<td>
|
||||||
required.
|
required.
|
||||||
|
|
@ -193,3 +40,126 @@ int tuples can be compared directly using binary operators (<, >).
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## versions.check
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
versions.check(<a href="#versions.check-minimum_bazel_version">minimum_bazel_version</a>, <a href="#versions.check-maximum_bazel_version">maximum_bazel_version</a>, <a href="#versions.check-bazel_version">bazel_version</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Check that the version of Bazel is valid within the specified range.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="versions.check-minimum_bazel_version">
|
||||||
|
<td><code>minimum_bazel_version</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
minimum version of Bazel expected
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="versions.check-maximum_bazel_version">
|
||||||
|
<td><code>maximum_bazel_version</code></td>
|
||||||
|
<td>
|
||||||
|
optional. default is <code>None</code>
|
||||||
|
<p>
|
||||||
|
maximum version of Bazel expected
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="versions.check-bazel_version">
|
||||||
|
<td><code>bazel_version</code></td>
|
||||||
|
<td>
|
||||||
|
optional. default is <code>None</code>
|
||||||
|
<p>
|
||||||
|
the version of Bazel to check. Used for testing, defaults to native.bazel_version
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## versions.is_at_most
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
versions.is_at_most(<a href="#versions.is_at_most-threshold">threshold</a>, <a href="#versions.is_at_most-version">version</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Check that a version is lower or equals to a threshold.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="versions.is_at_most-threshold">
|
||||||
|
<td><code>threshold</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
the maximum version string
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="versions.is_at_most-version">
|
||||||
|
<td><code>version</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
the version string to be compared to the threshold
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
## versions.is_at_least
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
versions.is_at_least(<a href="#versions.is_at_least-threshold">threshold</a>, <a href="#versions.is_at_least-version">version</a>)
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
Check that a version is higher or equals to a threshold.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<table class="params-table">
|
||||||
|
<colgroup>
|
||||||
|
<col class="col-param" />
|
||||||
|
<col class="col-description" />
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr id="versions.is_at_least-threshold">
|
||||||
|
<td><code>threshold</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
the minimum version string
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="versions.is_at_least-version">
|
||||||
|
<td><code>version</code></td>
|
||||||
|
<td>
|
||||||
|
required.
|
||||||
|
<p>
|
||||||
|
the version string to be compared to the threshold
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue