spikeinterface icon indicating copy to clipboard operation
spikeinterface copied to clipboard

Add ticks to all arguments referenced in docstrings

Open zm711 opened this issue 1 year ago • 3 comments

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

zm711 avatar Jun 27 '24 12:06 zm711

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!

chrishalcrow avatar Jun 28 '24 07:06 chrishalcrow

I like your definition of fun @chrishalcrow eheheheh

alejoe91 avatar Jun 28 '24 08:06 alejoe91

So, we should use the one that is used on markdown, that's here right?

h-mayorquin avatar Jul 03 '24 00:07 h-mayorquin

Yes @h-mayorquin the standard ` that is also used in markdown.

zm711 avatar Jul 10 '24 17:07 zm711