-
Notifications
You must be signed in to change notification settings - Fork 175
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
Add ticks to all arguments referenced in docstrings #3093
Labels
documentation
Improvements or additions to documentation
Comments
Yup, sounds good. Should we add this to the docstring conventions in the Developer notes? Once all the docstrings are formatted in the numpydoc style, it'll be fairly easy to extract all Parameters and check if they're in ticks in the other Parameter's descriptions. Fun! |
I like your definition of fun @chrishalcrow eheheheh |
So, we should use the one that is used on markdown, that's |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@JoeZiminski @chrishalcrow @h-mayorquin
Discussion in #3068 (specifically this thread)
In the library we've been a bit inconsistent about referencing other arguments inside docstrings. We had originally agreed on ticks, so for example
Does that sound good to everyone and something to add while working on numpydoc conventions?
The text was updated successfully, but these errors were encountered: