add doc for itercompat

2017-11-02 22:53:10 +08:00 · 2017-11-02 22:53:10 +08:00 · 19d39df798
parent 77bab1f07f
commit 19d39df798
2 changed files with 13 additions and 0 deletions
--- a/docs/index.rst
+++ b/docs/index.rst
@ -22,6 +22,7 @@ Content

   archive
   dict
+   itercompat
   misc
   set
   string
--- a/docs/itercompat.rst
+++ b/docs/itercompat.rst
@ -0,0 +1,12 @@
+Dict
+----
+
+.. class:: pydu.itercompat.is_iterable(x)
+
+    An implementation independent way of checking for iterables.
+
+    >>> from pydu.itercompat import is_iterable
+    >>> is_iterable([])
+    True
+    >>> is_iterable(1)
+    False