Status: Accepted
Owner: ----
Labels: Type-Defect Priority-Medium Documentation
New issue 3107 by [email protected]: docscrape.py extension only allows a
set number of headers
http://code.google.com/p/sympy/issues/detail?id=3107
From doc/ext/docscrape.py:
self._parsed_data = {
'Signature': '',
'Summary': [''],
'Extended Summary': [],
'Parameters': [],
'Returns': [],
'Raises': [],
'Warns': [],
'Other Parameters': [],
'Attributes': [],
'Methods': [],
'See Also': [],
'Notes': [],
'Warnings': [],
'References': '',
'Examples': '',
'index': {}
}
Only these header names can be used as underlined headers in docstrings.
But we should allow arbitrary headers. This would allow us to organize
long docstrings better (c.f. the simplify() docstring).
See the discussion at https://github.com/sympy/sympy/pull/1030#r415781.
--
You received this message because you are subscribed to the Google Groups
"sympy-issues" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sympy-issues?hl=en.
