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

Align pre-commit and Sphinx rule override syntax #466

Closed
stefanv opened this issue Jun 29, 2023 · 2 comments · Fixed by #476
Closed

Align pre-commit and Sphinx rule override syntax #466

stefanv opened this issue Jun 29, 2023 · 2 comments · Fixed by #476

Comments

@stefanv
Copy link
Contributor

stefanv commented Jun 29, 2023

See #454

/cc @stefmolin

@stefmolin
Copy link
Contributor

I'll start looking at this over the weekend.

@akaszynski
Copy link

If I'm not mistaken, we need this for http://github.com/pyvista/pyvista/ since our validation excludes several classes and methods:

numpydoc_validation_exclude = {  # set of regex
    r'\.BasePlotter$',  # Issue with class parameter documentation
    r'\.Plotter$',  # Issue with class parameter documentation
    r'\.WidgetHelper$',
    r'\.PickingHelper$',
    r'\.from_dict$',
    r'\.to_dict$',
    r'\.__init__$',
    r'\.__new__$',
]

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

Successfully merging a pull request may close this issue.

3 participants