sot / kadi

Chandra commands and events
https://sot.github.io/kadi
BSD 3-Clause "New" or "Revised" License
5 stars 3 forks source link

Convert docstrings to numpydoc style and refactor API docs #298

Closed taldcroft closed 7 months ago

taldcroft commented 7 months ago

Description

This converts all the docstrings to numpydoc style and refactors the API docs into separate files.

The automated update was done with below followed by some hand-edits to fix things up and make minor improvements along the way.

from skare3_tools.scripts import convert_numpydoc
convert_numpydoc.convert_directory_to_numpydoc("kadi")

Interface impacts

Testing

Unit tests

kadi/commands/tests/test_commands.py ........................................................................... [ 37%] kadi/commands/tests/test_states.py ......................x.............................................x............. [ 78%] .......... [ 83%] kadi/tests/test_events.py .......... [ 88%] kadi/tests/test_occweb.py ...................... [100%]

======================================== 197 passed, 2 xfailed in 104.52s (0:01:44) =========================================

Independent check of unit tests by [REVIEWER NAME]
- [ ] [PLATFORM]:

### Functional tests
<!-- Describe and document results of any functional tests, otherwise leave the text below -->

cd docs make html # No warnings open _build/html/index.html # looks OK