Skip to content

Add ticks to all arguments referenced in docstrings #3093

Open
@zm711

Description

@zm711

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions