From 5c79a8a62d54672d2734ecced64b346566cc1fa8 Mon Sep 17 00:00:00 2001 From: Mahmoud Hashemi Date: Thu, 24 Sep 2015 11:51:21 -0700 Subject: [PATCH] a bunch of docs cleanups --- boltons/iterutils.py | 5 +++++ docs/iterutils.rst | 6 ++++-- requirements-rtd.txt | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/boltons/iterutils.py b/boltons/iterutils.py index 198b1ce..64423df 100644 --- a/boltons/iterutils.py +++ b/boltons/iterutils.py @@ -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? diff --git a/docs/iterutils.rst b/docs/iterutils.rst index 26555b1..654ed8a 100644 --- a/docs/iterutils.rst +++ b/docs/iterutils.rst @@ -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 diff --git a/requirements-rtd.txt b/requirements-rtd.txt index 1a01637..daeddff 100644 --- a/requirements-rtd.txt +++ b/requirements-rtd.txt @@ -1,2 +1,2 @@ sphinxcontrib-napoleon -sphinx_rtd_theme +# sphinx_rtd_theme # you'll need sphinx_rtd_theme for local dev