Add module for converting docstrings to numpydoc format #101
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This provides a module (and eventually a command line script) to convert from ReST format docstrings to numpydocs format.
I spent some time trying to use the
pyment
package but found that it does not handle any docstring with inline examples. After an hour trying to make that package work I bailed. In the end some customization was useful -- we have used non-standard conventions in docstrings over the years and this code tries to do the best with what's there.The ReST format which is used in most Ska packages is unsatisfactory because it does not really support indicating the type of input parameters. It is also a bit tired and doesn't look nice.
Interface impacts
None
Testing
Unit tests
Functional tests
See sot/chandra_aca#156 and rendered output in the description.