mirror of https://github.com/mahmoud/boltons.git
a bunch of docs cleanups
This commit is contained in:
parent
275a290ea7
commit
5c79a8a62d
|
@ -730,7 +730,12 @@ def remap(root, visit=default_visit, enter=default_enter, exit=default_exit,
|
|||
function call the default behavior before or after your custom
|
||||
logic. See `this example`_.
|
||||
|
||||
Duplicate and self-referential objects (aka reference loops) are
|
||||
automatically handled internally, `as shown here`_.
|
||||
|
||||
.. _this example: http://sedimental.org/remap.html#sort_all_lists
|
||||
.. _as shown here: http://sedimental.org/remap.html#corner_cases
|
||||
|
||||
"""
|
||||
# TODO: improve argument formatting in sphinx doc
|
||||
# TODO: enter() return (False, items) to continue traverse but cancel copy?
|
||||
|
|
|
@ -29,8 +29,10 @@ Nested
|
|||
Nested data structures are common. Yet virtually all of Python's
|
||||
compact iteration tools work with flat data: list comprehensions,
|
||||
map/filter, generator expressions, itertools, even other
|
||||
iterutils. These functions make working with nested iterables and
|
||||
other containers as succinct and powerful as Python itself.
|
||||
iterutils.
|
||||
|
||||
The functions below make working with nested iterables and other
|
||||
containers as succinct and powerful as Python itself.
|
||||
|
||||
.. autofunction:: remap
|
||||
|
||||
|
|
|
@ -1,2 +1,2 @@
|
|||
sphinxcontrib-napoleon
|
||||
sphinx_rtd_theme
|
||||
# sphinx_rtd_theme # you'll need sphinx_rtd_theme for local dev
|
||||
|
|
Loading…
Reference in New Issue