Closed taldcroft closed 4 years ago
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 of pyment with pip.
numpydoc
pyment
~/.local/bin/pyment --output numpydoc --write --convert xija
There is room for improvement in the actual values of parameters etc., but this PR is just about migration.
Built HTML documentation with no warnings. The API docs appear as expected.
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.