Rooba
/
boltons
mirror of https://github.com/mahmoud/boltons.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

swizzle around iterutils docs a bit

This commit is contained in:
Mahmoud Hashemi 2020-06-21 22:30:24 -07:00
parent 4de495908c
commit 962b217339
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/iterutils.rst
View File

@ -16,14 +16,6 @@ These are generators and convenient :class:`list`-producing
counterparts comprising several common patterns of iteration not counterparts comprising several common patterns of iteration not
present in the standard library. present in the standard library.
.. autofunction:: split
.. autofunction:: split_iter
.. autofunction:: strip
.. autofunction:: strip_iter
.. autofunction:: lstrip
.. autofunction:: lstrip_iter
.. autofunction:: rstrip
.. autofunction:: rstrip_iter
.. autofunction:: chunked .. autofunction:: chunked
.. autofunction:: chunked_iter .. autofunction:: chunked_iter
.. autofunction:: pairwise .. autofunction:: pairwise
@ -33,6 +25,21 @@ present in the standard library.
.. autofunction:: unique .. autofunction:: unique
.. autofunction:: unique_iter .. autofunction:: unique_iter
Stripping and splitting
-----------------------
A couple of :class:`str`-inspired mechanics that have come in handy on
iterables, too:
.. autofunction:: split
.. autofunction:: split_iter
.. autofunction:: strip
.. autofunction:: strip_iter
.. autofunction:: lstrip
.. autofunction:: lstrip_iter
.. autofunction:: rstrip
.. autofunction:: rstrip_iter
Nested Nested
------ ------
@ -81,6 +88,7 @@ The built-in :func:`sorted()` is great, but what do you do when you want to
partially override the sort order? partially override the sort order?
.. autofunction:: soft_sorted .. autofunction:: soft_sorted
.. autofunction:: untyped_sorted
Reduction Reduction
--------- ---------