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

Ignore documentation errors in Sphinx config #183

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

kroeschl
Copy link
Contributor

We don't want to fiddle with docstrings or related noqas in our Sphinx configs. To avoid this, disable docs rules in docs/conf.py.

Tested by installing into a package's Poetry env and running ni-python-styleguide lint. It now doesn't complain about missing docstrings in docs/conf.py.

Copy link
Contributor

Thank you for contributing! 👋

@kroeschl kroeschl marked this pull request as ready for review June 11, 2024 13:00
@mshafer-NI
Copy link
Collaborator

So..., my first thought was to say "no", we already have a doc-string in the suggested templates. But, it's a useless string "docs for {module}"...

And this makes adoption simpler....

Agreeing.

@irwand irwand merged commit 5f0120d into ni:main Jun 11, 2024
17 checks passed
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 this pull request may close these issues.

3 participants