Skip to content
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

Open
zm711 opened this issue Jun 27, 2024 · 4 comments
Open

Add ticks to all arguments referenced in docstrings #3093

zm711 opened this issue Jun 27, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@zm711
Copy link
Collaborator

zm711 commented Jun 27, 2024

@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 zm711 added the documentation Improvements or additions to documentation label Jun 27, 2024
@chrishalcrow
Copy link
Collaborator

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!

@alejoe91
Copy link
Member

I like your definition of fun @chrishalcrow eheheheh

@h-mayorquin
Copy link
Collaborator

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

@zm711
Copy link
Collaborator Author

zm711 commented Jul 10, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants