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

Shorter section underlines trigger ambiguous validation #460

Open
HealthyPear opened this issue Jun 7, 2023 · 0 comments
Open

Shorter section underlines trigger ambiguous validation #460

HealthyPear opened this issue Jun 7, 2023 · 0 comments

Comments

@HealthyPear
Copy link

While testing #454 I noticed that for the following docstring,

    """Bad, bad docstring!

    Parameters
    ---------
    x : `int`
    y:
        Another variable.

    Returns
    -------
    z : `int`
        The sum of ``x`` and ``y``.
    """

which contains many issues, but the issue of the shorter underline triggers a rather misterious
PR01 | Parameters {'x', 'y'} not documented.

In fact, after adding the missing dash I get the next issues, PR01, PR02, PR07 and PR10.

From the list of available validation checks the shorter underline problem is not present, I guess because it's more an RsT issue, but since numpydoc uses RsT (unless I overlooked this), I think it should be a proper validation check.

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

No branches or pull requests

1 participant