sot / xija

Thermal modeling framework for Chandra X-ray Observatory
https://sot.github.io/xija
BSD 3-Clause "New" or "Revised" License
9 stars 5 forks source link

Migrate all doc strings to use numpydoc #97

Closed taldcroft closed 4 years ago

taldcroft commented 4 years ago

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 of pyment with pip.

~/.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.

Testing

Functional testing

Built HTML documentation with no warnings. The API docs appear as expected.