Migrate all doc strings to use numpydoc #97
Merged
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 migrates all the docstrings for xija to use the
numpydoc
style / extension. The actual docstring migration was done fully automatically with the statement below after doing a --user local install ofpyment
with pip.There is room for improvement in the actual values of parameters etc., but this PR is just about migration.
Testing
Functional testing
Built HTML documentation with no warnings. The API docs appear as expected.