bazel
/
bazel-skylib
mirror of https://github.com/bazelbuild/bazel-skylib
2
0
Fork 0
Code Issues Releases Activity

Update dicts documentation. (#361)

This commit is contained in:
Alexandre Rostovtsev 2022-03-28 12:06:10 -04:00 committed by GitHub
parent 8334f938c1
commit b669088a95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/dicts_doc.md
View File

@ -34,3 +34,49 @@ dictionary, and the sum of a single dictionary is a copy of itself.
A new `dict` that has all the entries of the given dictionaries.
<a id="#dicts.omit"></a>
## dicts.omit
<pre>
dicts.omit(<a href="#dicts.omit-dictionary">dictionary</a>, <a href="#dicts.omit-keys">keys</a>)
</pre>
Returns a new `dict` that has all the entries of `dictionary` with keys not in `keys`.
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="dicts.omit-dictionary"></a>dictionary | A <code>dict</code>. | none |
| <a id="dicts.omit-keys"></a>keys | A sequence. | none |
**RETURNS**
A new `dict` that has all the entries of `dictionary` with keys not in `keys`.
<a id="#dicts.pick"></a>
## dicts.pick
<pre>
dicts.pick(<a href="#dicts.pick-dictionary">dictionary</a>, <a href="#dicts.pick-keys">keys</a>)
</pre>
Returns a new `dict` that has all the entries of `dictionary` with keys in `keys`.
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="dicts.pick-dictionary"></a>dictionary | A <code>dict</code>. | none |
| <a id="dicts.pick-keys"></a>keys | A sequence. | none |
**RETURNS**
A new `dict` that has all the entries of `dictionary` with keys in `keys`.