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 all of the docstrings on public-facing APIs to numpy style #1001

Merged
merged 24 commits into from
Jan 31, 2023

Conversation

jleibs
Copy link
Member

@jleibs jleibs commented Jan 30, 2023

This gives us proper rendering of the docstrings in the generated docs:

image

Maybe worth reviewing the actual generated docs locally by checking out the branch and:

just py-docs-serve

The docs in question are mostly contained within: http://127.0.0.1:8000/common/

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I've added a line to CHANGELOG.md (if this is a big enough change to warrant it)

@jleibs jleibs marked this pull request as ready for review January 31, 2023 00:06
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

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

Wow, this is wonderful, and we don't have to repeat the parameter types in the docs! 🥳

@emilk emilk merged commit 1838b71 into main Jan 31, 2023
@emilk emilk deleted the jleibs/numpy_docstrings branch January 31, 2023 05:06
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