feat: add pylint for docs #202
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
abenseny
previously approved these changes
Oct 7, 2021
docs/conf.py
Outdated
| # list see the documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
| """ | ||
|
|
||
| # Configuration file for the Sphinx documentation builder. |
Member
There was a problem hiding this comment.
This line is now repeated in the module docstring and as a comment. Do we need both?
Contributor
Author
There was a problem hiding this comment.
Not really, i was a little torn about including that whole message below in the module docstring or disabling the docstring entirely. I think ill get rid of the additional comment and keep the docstring however
abenseny
approved these changes
Oct 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Addresses: https://q-ctrl.atlassian.net/browse/devops-696