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

API-doc has run-on sentences #2422

Open
purva-thakre opened this issue Jun 26, 2024 · 5 comments
Open

API-doc has run-on sentences #2422

purva-thakre opened this issue Jun 26, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@purva-thakre
Copy link
Collaborator

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.

Intended in API-doc
image image
@purva-thakre purva-thakre added the bug Something isn't working label Jun 26, 2024
@purva-thakre
Copy link
Collaborator Author

@natestemen Is this what you were referring to?

@natestemen natestemen added documentation Improvements or additions to documentation and removed bug Something isn't working labels Jun 26, 2024
@natestemen
Copy link
Member

Not really. I was thinking we could take inspiration from how numpy documents kwargs objects, but I haven't been able to find what I was looking for. One thing I did find, however, was that for numpy.clip they redirect to a different page for info on what kwargs can look like. Not necessarily suggesting we do that, just worth noting.

@cosenal
Copy link
Contributor

cosenal commented Oct 1, 2024

See #2472 for a related issue and potentially a solution that could fix both. 🐦‍⬛🐦‍⬛ 🥌

@Kuzay3t
Copy link

Kuzay3t commented Oct 12, 2024

I want to help, how can i assist?

@natestemen
Copy link
Member

The goal here is to go through the docstrings and ensure kwargs variables are formatted properly. You can find an example where this is not the case in the issue description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants