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

Update docstrings, use numpydoc over napoleon #86

Merged
merged 6 commits into from
Jun 3, 2023
Merged

Update docstrings, use numpydoc over napoleon #86

merged 6 commits into from
Jun 3, 2023

Conversation

simonbowly
Copy link
Member

@simonbowly simonbowly commented Jun 2, 2023

Addresses #66

  • Use numpydoc over napoleon (seems to be cleaner, handles intersphinx properly)
  • Update intersphinx mappings
  • Add numpydoc aliases
  • Update docstrings of (almost all) mods
  • Update docstring of MVP mod (holding off to avoid conflicts with Change portfolio return type #84)

@rluce
Copy link
Member

rluce commented Jun 2, 2023

Not sure if it does more harm than help, but here is the torturous tool... https://www.pydocstyle.org/en/6.3.0/usage.html

@simonbowly
Copy link
Member Author

Maybe later ... for now it's a wall of warnings, e.g.:

D401: First line should be in imperative mood; try rephrasing (found 'This')

@simonbowly simonbowly marked this pull request as ready for review June 3, 2023 04:20
@simonbowly simonbowly merged commit dd32f7d into main Jun 3, 2023
@simonbowly simonbowly deleted the numpydoc branch June 3, 2023 04:20
@simonbowly simonbowly mentioned this pull request Jun 5, 2023
3 tasks
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.

None yet

2 participants