add comment on _spec

[ieee754fpu.git] / src / add / stageapi.py

diff --git a/src/add/stageapi.py b/src/add/stageapi.py
index eb90315c7fcc70518839ed95403ad2a1831bec91..dd969ae4ab3fc76d0404e9b7abd41c7c9cfae78d 100644 (file)
--- a/src/add/stageapi.py
+++ b/src/add/stageapi.py
@@ -80,6 +80,13 @@ import nmoperator
 
 
 def _spec(fn, name=None):
+    """ useful function that determines if "fn" has an argument "name".
+        if so, fn(name) is called otherwise fn() is called.
+
+        means that ispec and ospec can be declared with *or without*
+        a name argument.  normally it would be necessary to have
+        "ispec(name=None)" to achieve the same effect.
+    """
     if name is None:
         return fn()
     varnames = dict(inspect.getmembers(fn.__code__))['co_varnames']