Skip to content

Commit c917226

Browse files
committed
Note on methods
1 parent 7fa273c commit c917226

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

numpydoc/docscrape_sphinx.py

+7
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,13 @@ def _process_param(self, param, desc, autosum):
108108
``desc``, if ``autosum is None`` or ``param`` is not a class
109109
attribute, or it will be a summary of the class attribute's
110110
docstring.
111+
112+
Notes
113+
-----
114+
This does not have the autosummary functionality to display a method's
115+
signature, and hence is not used to format methods. It may be
116+
complicated to incorporate autosummary's signature mangling, as it
117+
relies on Sphinx's plugin mechanism.
111118
"""
112119
param = param.strip()
113120
display_param = '**%s**' % param

0 commit comments

Comments
 (0)