Add ticks to all arguments referenced in docstrings
@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
def a_function(a, b):
"""
Parameters
----------
a : array
the data
b : bool
whether to scale the data in `a`
"""
Does that sound good to everyone and something to add while working on numpydoc conventions?
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 here right?
Yes @h-mayorquin the standard ` that is also used in markdown.