Ignore documentation errors in Sphinx config #183
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for contributing! 👋 |
|
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. |
mshafer-NI
approved these changes
Jun 11, 2024
irwand
approved these changes
Jun 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 indocs/conf.py.