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.

Sign up for GitHub

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

Jump to bottom

Feature request: numpydoc rules #8425

Open
njzjz opened this issue Nov 1, 2023 · 2 comments
Open

Feature request: numpydoc rules #8425

njzjz opened this issue Nov 1, 2023 · 2 comments
Labels
needs-decision Awaiting a decision from a maintainer plugin Implementing a known but unsupported plugin

Comments

@njzjz
Copy link

njzjz commented Nov 1, 2023

See https://numpydoc.readthedocs.io/en/latest/validation.html.

It would be nice if ruff implemented some of numpydoc rules that are not supported by pydocstyle, such as PR10

    "PR10": 'Parameter "{param_name}" requires a space before the colon '
    "separating the parameter name and type",
@njzjz njzjz changed the title Frature request: numpydoc rules Feature request: numpydoc rules Nov 2, 2023
@charliermarsh charliermarsh added plugin Implementing a known but unsupported plugin needs-decision Awaiting a decision from a maintainer labels Nov 2, 2023
@timj
Copy link

timj commented Dec 6, 2023

ruff supporting numpydoc rules would be incredibly helpful.

@namurphy namurphy mentioned this issue Dec 22, 2023
Closed
@albeanth albeanth mentioned this issue Jan 29, 2024
Closed
@till-m till-m mentioned this issue Jul 27, 2024
Merged
@augustebaum
Copy link

+1

@visr visr mentioned this issue Sep 3, 2024
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
needs-decision Awaiting a decision from a maintainer plugin Implementing a known but unsupported plugin
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@timj @charliermarsh @njzjz @augustebaum