Merge pull request #11 from eriknw/embedsignature

Add function signature to docstrings

cytoolz/curried_exceptions.pyx

@@ -1,10 +1,12 @@
+#cython: embedsignature=True
 from .dicttoolz cimport c_merge_with
 
 __all__ = ['merge_with']
 
 
 def merge_with(func, *dicts):
-    """ Merge dictionaries and apply function to combined values
+    """
+    Merge dictionaries and apply function to combined values
 
     A key may occur in more than one dict, and all values mapped from the key
     will be passed to the function as a list, such as func([val1, val2, ...]).

cytoolz/dicttoolz.pyx

@@ -1,3 +1,4 @@
+#cython: embedsignature=True
 from cpython.dict cimport (PyDict_Check, PyDict_GetItem, PyDict_Merge,
                            PyDict_New, PyDict_SetItem, PyDict_Update)
 from cpython.exc cimport PyErr_Clear, PyErr_GivenExceptionMatches, PyErr_Occurred
@@ -21,7 +22,8 @@ cdef dict c_merge(object dicts):
 
 
 def merge(*dicts):
-    """ Merge a collection of dictionaries
+    """
+    Merge a collection of dictionaries
 
     >>> merge({1: 'one'}, {2: 'two'})
     {1: 'one', 2: 'two'}
@@ -61,7 +63,8 @@ cdef dict c_merge_with(object func, object dicts):
 
 
 def merge_with(func, *dicts):
-    """ Merge dictionaries and apply function to combined values
+    """
+    Merge dictionaries and apply function to combined values
 
     A key may occur in more than one dict, and all values mapped from the key
     will be passed to the function as a list, such as func([val1, val2, ...]).
@@ -81,7 +84,8 @@ def merge_with(func, *dicts):
 
 
 cpdef dict valmap(object func, dict d):
-    """ Apply function to values of dictionary
+    """
+    Apply function to values of dictionary
 
     >>> bills = {"Alice": [20, 15, 30], "Bob": [10, 35]}
     >>> valmap(sum, bills)  # doctest: +SKIP
@@ -98,7 +102,8 @@ cpdef dict valmap(object func, dict d):
 
 
 cpdef dict keymap(object func, dict d):
-    """ Apply function to keys of dictionary
+    """
+    Apply function to keys of dictionary
 
     >>> bills = {"Alice": [20, 15, 30], "Bob": [10, 35]}
     >>> keymap(str.lower, bills)  # doctest: +SKIP
@@ -115,7 +120,8 @@ cpdef dict keymap(object func, dict d):
 
 
 cpdef dict valfilter(object predicate, dict d):
-    """ Filter items in dictionary by value
+    """
+    Filter items in dictionary by value
 
     >>> iseven = lambda x: x % 2 == 0
     >>> d = {1: 2, 2: 3, 3: 4, 4: 5}
@@ -135,7 +141,8 @@ cpdef dict valfilter(object predicate, dict d):
 
 
 cpdef dict keyfilter(object predicate, dict d):
-    """ Filter items in dictionary by key
+    """
+    Filter items in dictionary by key
 
     >>> iseven = lambda x: x % 2 == 0
     >>> d = {1: 2, 2: 3, 3: 4, 4: 5}
@@ -172,7 +179,8 @@ cpdef dict assoc(dict d, object key, object value):
 
 
 cpdef dict update_in(dict d, object keys, object func, object default=None):
-    """ Update value in a (potentially) nested dictionary
+    """
+    Update value in a (potentially) nested dictionary
 
     inputs:
     d - dictionary on which to operate

cytoolz/functoolz.pyx

@@ -1,3 +1,4 @@
+#cython: embedsignature=True
 import inspect
 from cpython.dict cimport PyDict_Merge, PyDict_New
 from cpython.exc cimport PyErr_Clear, PyErr_ExceptionMatches, PyErr_Occurred
@@ -34,7 +35,8 @@ cdef object c_thread_first(object val, object forms):
 
 
 def thread_first(val, *forms):
-    """ Thread value through a sequence of functions/forms
+    """
+    Thread value through a sequence of functions/forms
 
     >>> def double(x): return 2*x
     >>> def inc(x):    return x + 1
@@ -75,7 +77,8 @@ cdef object c_thread_last(object val, object forms):
 
 
 def thread_last(val, *forms):
-    """ Thread value through a sequence of functions/forms
+    """
+    Thread value through a sequence of functions/forms
 
     >>> def double(x): return 2*x
     >>> def inc(x):    return x + 1
@@ -107,7 +110,8 @@ def thread_last(val, *forms):
 
 
 cpdef object _num_required_args(object func):
-    """ Number of args for func
+    """
+    Number of args for func
 
     >>> def foo(a, b, c=None):
     ...     return a + b + c
@@ -133,7 +137,9 @@ cpdef object _num_required_args(object func):
 
 
 cdef class curry:
-    """ Curry a callable function
+    """ curry(self, func, *args, **kwargs)
+
+    Curry a callable function
 
     Enables partial application of arguments through calling a function with an
     incomplete set of arguments.
@@ -158,7 +164,7 @@ cdef class curry:
 
     See Also:
         cytoolz.curried - namespace of curried functions
-                          http://toolz.readthedocs.org/en/latest/curry.html
+                        http://toolz.readthedocs.org/en/latest/curry.html
     """
     property __doc__:
         def __get__(self):
@@ -269,7 +275,8 @@ cdef class c_memoize:
 
 
 cpdef object memoize(object func=None, object cache=None, object key=None):
-    """ Cache a function's result for speedy future evaluation
+    """
+    Cache a function's result for speedy future evaluation
 
     Considerations:
         Trades memory for speed.
@@ -311,7 +318,9 @@ cpdef object memoize(object func=None, object cache=None, object key=None):
 
 
 cdef class Compose:
-    """ A composition of functions
+    """ Compose(self, *funcs)
+
+    A composition of functions
 
     See Also:
         compose
@@ -338,7 +347,8 @@ cdef object c_compose(object funcs):
 
 
 def compose(*funcs):
-    """ Compose functions to operate in series.
+    """
+    Compose functions to operate in series.
 
     Returns a function that applies other functions in sequence.
 
@@ -365,7 +375,8 @@ cdef object c_pipe(object data, object funcs):
 
 
 def pipe(data, *funcs):
-    """ Pipe a value through a sequence of functions
+    """
+    Pipe a value through a sequence of functions
 
     I.e. ``pipe(data, f, g, h)`` is equivalent to ``h(g(f(data)))``
 
@@ -387,7 +398,9 @@ def pipe(data, *funcs):
 
 
 cdef class complement:
-    """ Convert a predicate function to its logical complement.
+    """ complement(func)
+
+    Convert a predicate function to its logical complement.
 
     In other words, return a function that, for inputs that normally
     yield True, yields False, and vice-versa.
@@ -445,7 +458,8 @@ def juxt(*funcs):
 
 
 cpdef object do(object func, object x):
-    """ Runs ``func`` on ``x``, returns ``x``
+    """
+    Runs ``func`` on ``x``, returns ``x``
 
     Because the results of ``func`` are not returned, only the side
     effects of ``func`` are relevant.