added itertools docs

fixes #954
2016-12-22 16:20:30 -08:00 · 2016-12-22 16:20:30 -08:00 · 0379fa1b36
commit 0379fa1b36
parent ca6fd66606
1 changed files with 19 additions and 0 deletions
--- a/docs/language/core.rst
+++ b/docs/language/core.rst
@ -1280,3 +1280,22 @@ also includes all Python reserved words. All names are in unmangled form
   => (import hy)
   => (in "defclass" (hy.core.reserved.names))
   True
+
+
+Included itertools
+==================
+
+All of Python's itertools are available, however some of the names have been
+changed:
+
+- `starmap` has been changed to `*map`
+
+
+  - `combinations_with_replacement` has been changed to `multicombinations`
+
+  - `groupby` has been changed to`group-by`
+
+  - `takewhile` has been changed to `take-while`
+
+  Please refer to the `Python documentation
+  <https://docs.python.org/3/library/itertools.html>`_ for more information.