Docstandard #61
Docstandard #61
Conversation
|
The text all looks fine to me. |
|
Some commends: "If references are not referred to in the docstring text, the numbering can be omitted." The module docstring part might need some revision in the future -- I think a reasonable aim is to move the sphinx module docs to the module docstrings. |
|
I was just documenting there what has been done recently, mainly by David G.. I'm fine with leaving off the sentence "If references are not referred to in the docstring text, the numbering can be omitted." and putting back numbering everywhere. I like the moving module docstrings idea too; never saw the point of the info.py files. But I think that should not prevent committing the current edits, it's more or less an orthogonal issue. |
|
I think the edits are OK to go in. The module issue can be addressed later on. |
|
OK, committed. |
feat: Add vcreate_s8
Some changes to the docstandard. Closes tickets 1165, 1280, 1501, 1509 and 1524.
For the deprecation section I chose to use the note directive instead of the deprecated directive, because the latter does not seem to work well with the docstring parsing machinery. It concatenates summary line, deprecation message and extended summary.