Merge pull request #13 from petbox-dev/develop

update docs
petbox-dev · Jun 13, 2020 · dbe102b · dbe102b
2 parents e34a0a5 + ebd533c
commit dbe102b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/README.rst b/README.rst
@@ -84,8 +84,9 @@ and SQL-style "group by" and join operations.
 |                            | `itertuples <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.itertuples>`_,                                |
 |                            | `itercols <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.itercols>`_                                     |
 +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
-| Functional Methods         | `row_map <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.row_map>`_                                       |
-|                            | `col_map <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.col_map>`_,                                      |
+| Functional Methods         | `row_map <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.row_map>`_,                                      |
+|                            | `tuple_map <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.tuple_map>`_,                                  |
+|                            | `col_map <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.col_map>`_                                       |
 +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
 | Dict-like Methods          | `keys <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.keys>`_,                                            |
 |                            | `values <https://tafra.readthedocs.io/en/latest/api.html#tafra.base.Tafra.values>`_,                                        |

diff --git a/tafra/base.py b/tafra/base.py
@@ -1192,9 +1192,9 @@ def row_map(self, fn: Callable[..., Any], *args: Any, **kwargs: Any) -> Iterator
 
     def tuple_map(self, fn: Callable[..., Any], *args: Any, **kwargs: Any) -> Iterator[Any]:
         """
-        Map a function over rows. To apply to specific columns, use
-        :meth:`select` first. The function must operate on :class:`NamedTuple` from
-        :meth:`itertuples`.
+        Map a function over rows. This is faster than :meth:`row_map`. To apply
+        to specific columns, use :meth:`select` first. The function must operate
+        on :class:`NamedTuple` from :meth:`itertuples`.
 
         Parameters
         ----------