Open
Description
@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?