diff options
Diffstat (limited to 'docs/types_doc.md')
| -rwxr-xr-x | docs/types_doc.md | 305 |
1 files changed, 134 insertions, 171 deletions
diff --git a/docs/types_doc.md b/docs/types_doc.md index 038ae0a..7ab0a6c 100755 --- a/docs/types_doc.md +++ b/docs/types_doc.md @@ -1,3 +1,9 @@ +<!-- Generated with Stardoc: http://skydoc.bazel.build --> + +Skylib module containing functions checking types. + +<a id="#types.is_list"></a> + ## types.is_list <pre> @@ -6,26 +12,19 @@ types.is_list(<a href="#types.is_list-v">v</a>) Returns True if v is an instance of a list. -### Parameters - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="types.is_list-v"> - <td><code>v</code></td> - <td> - required. - <p> - The value whose type should be checked. - </p> - </td> - </tr> - </tbody> -</table> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_list-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v is an instance of a list, False otherwise. + +<a id="#types.is_string"></a> ## types.is_string @@ -35,27 +34,20 @@ types.is_string(<a href="#types.is_string-v">v</a>) Returns True if v is an instance of a string. -### Parameters - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="types.is_string-v"> - <td><code>v</code></td> - <td> - required. - <p> - The value whose type should be checked. - </p> - </td> - </tr> - </tbody> -</table> +**PARAMETERS** +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_string-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v is an instance of a string, False otherwise. + + +<a id="#types.is_bool"></a> + ## types.is_bool <pre> @@ -64,26 +56,19 @@ types.is_bool(<a href="#types.is_bool-v">v</a>) 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> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_bool-v"></a>v | The value whose type should be checked. | none | +**RETURNS** + +True if v is an instance of a bool, False otherwise. + + +<a id="#types.is_none"></a> ## types.is_none @@ -93,26 +78,19 @@ types.is_none(<a href="#types.is_none-v">v</a>) 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> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_none-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v is None, False otherwise. + +<a id="#types.is_int"></a> ## types.is_int @@ -122,27 +100,20 @@ types.is_int(<a href="#types.is_int-v">v</a>) 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> +**PARAMETERS** +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_int-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v is an instance of a signed integer, False otherwise. + + +<a id="#types.is_tuple"></a> + ## types.is_tuple <pre> @@ -151,26 +122,19 @@ types.is_tuple(<a href="#types.is_tuple-v">v</a>) Returns True if v is an instance of a tuple. -### Parameters - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <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> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_tuple-v"></a>v | The value whose type should be checked. | none | +**RETURNS** + +True if v is an instance of a tuple, False otherwise. + + +<a id="#types.is_dict"></a> ## types.is_dict @@ -180,26 +144,19 @@ types.is_dict(<a href="#types.is_dict-v">v</a>) 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> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_dict-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v is an instance of a dict, False otherwise. + +<a id="#types.is_function"></a> ## types.is_function @@ -209,27 +166,20 @@ types.is_function(<a href="#types.is_function-v">v</a>) 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> +**PARAMETERS** +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_function-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v is an instance of a function, False otherwise. + + +<a id="#types.is_depset"></a> + ## types.is_depset <pre> @@ -238,24 +188,37 @@ types.is_depset(<a href="#types.is_depset-v">v</a>) 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> - required. - <p> - The value whose type should be checked. - </p> - </td> - </tr> - </tbody> -</table> +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_depset-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v is an instance of a `depset`, False otherwise. + + +<a id="#types.is_set"></a> + +## types.is_set + +<pre> +types.is_set(<a href="#types.is_set-v">v</a>) +</pre> + +Returns True if v is a set created by sets.make(). + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="types.is_set-v"></a>v | The value whose type should be checked. | none | + +**RETURNS** + +True if v was created by sets.make(), False otherwise. |