-
-
Notifications
You must be signed in to change notification settings - Fork 163
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
API-doc has run-on sentences #2422
Comments
@natestemen Is this what you were referring to? |
Not really. I was thinking we could take inspiration from how numpy documents |
See #2472 for a related issue and potentially a solution that could fix both. 🐦⬛🐦⬛ 🥌 |
I want to help, how can i assist? |
The goal here is to go through the docstrings and ensure |
As we rely on google-style docstrings, there is no convention to allow lists in the description of the different sections of a docstring. Portions of our API-doc have run-on sentences because someone used a list in the section description which appears as badly formatted sentences publicly.
The text was updated successfully, but these errors were encountered: