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

Migrate all doc strings to use numpydoc #97

Merged
merged 5 commits into from
Oct 2, 2020
Merged

Migrate all doc strings to use numpydoc #97

merged 5 commits into from
Oct 2, 2020

Conversation

taldcroft
Copy link
Member

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

  • [N/A] Passes unit tests on MacOS, linux, Windows (at least one required)
  • Functional testing

Functional testing

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

@taldcroft taldcroft merged commit 64b8108 into master Oct 2, 2020
@taldcroft taldcroft deleted the numpydocs branch October 2, 2020 00:05
@javierggt javierggt mentioned this pull request Dec 7, 2020
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.

1 participant