Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert docstrings to numpydoc style and refactor API docs #298

Merged
merged 2 commits into from
Nov 21, 2023

Conversation

taldcroft
Copy link
Member

@taldcroft taldcroft commented Nov 19, 2023

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

  • Mac
(ska3-perf) ➜  kadi git:(numpydoc) git rev-parse HEAD
c2c2b9c775b7d29919feea5bdd2411627c4554e8
(ska3-perf) ➜  kadi git:(numpydoc) pytest kadi             
==================================================== test session starts ====================================================
platform darwin -- Python 3.10.8, pytest-7.2.1, pluggy-1.0.0
rootdir: /Users/aldcroft/git, configfile: pytest.ini
plugins: timeout-2.1.0, anyio-3.6.2
collected 199 items                                                                                                         

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

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

@taldcroft taldcroft requested a review from javierggt November 21, 2023 17:38
Copy link
Contributor

@javierggt javierggt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went over the changes and they make sense to me. I also made the documentation locally and the differences seem small.

@taldcroft taldcroft merged commit e659664 into master Nov 21, 2023
4 checks passed
@taldcroft taldcroft deleted the numpydoc branch November 21, 2023 22:15
@javierggt javierggt mentioned this pull request Dec 5, 2023
@javierggt javierggt mentioned this pull request Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants