Note on methods

numpy · Sep 7, 2017 · c917226 · c917226
1 parent 7fa273c
commit c917226
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/numpydoc/docscrape_sphinx.py b/numpydoc/docscrape_sphinx.py
@@ -108,6 +108,13 @@ def _process_param(self, param, desc, autosum):
             ``desc``, if ``autosum is None`` or ``param`` is not a class
             attribute, or it will be a summary of the class attribute's
             docstring.
+
+        Notes
+        -----
+        This does not have the autosummary functionality to display a method's
+        signature, and hence is not used to format methods.  It may be
+        complicated to incorporate autosummary's signature mangling, as it
+        relies on Sphinx's plugin mechanism.
         """
         param = param.strip()
         display_param = '**%s**' % param