Added a note on FunctionMaker.create

1 files changed, 13 insertions, 1 deletions

diff --git a/src/tests/documentation.py b/src/tests/documentation.py
index 8282063..cdee30f 100644
--- a/src/tests/documentation.py
+++ b/src/tests/documentation.py
@@ -535,6 +535,19 @@ the names of the mandatory arguments) an attribute ``arg0``, ``arg1``,
 ..., ``argN`` is also generated. Finally, there is a ``signature``
 attribute, a string with the signature of the original function.
 
+Notice: you should not pass signature strings with default arguments,
+i.e. something like 'f1(a, b=None)'. Just pass 'f1(a, b)' and then
+a tuple of defaults:
+
+.. code-block:: python
+
+ >>> f1 = FunctionMaker.create(
+ ...     'f1(a, b)', 'f(a, b)', dict(f=f), addsource=True, defaults=(None,))
+ >>> import inspect
+ >>> print(inspect.getargspec(f1))
+ ArgSpec(args=['a', 'b'], varargs=None, keywords=None, defaults=(None,))
+
+
 Getting the source code
 ---------------------------------------------------
 
@@ -553,7 +566,6 @@ $$example
 
 .. code-block:: python
 
- >>> import inspect
  >>> print(inspect.getsource(example))
      def wrapper(*args, **kw):
          return func(*args, **kw)