Enable doc8 and improve display of supported env vars #3298
+112
−57
Conversation
This file contains 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
webknjaz
reviewed
Nov 10, 2021
webknjaz
reviewed
Nov 10, 2021
| MOLECULE_VERIFIER_NAME Name of the verifier tool (usually 'ansible') | ||
| MOLECULE_VERIFIER_TEST_DIRECTORY ? | ||
| ================================ =========================================================== | ||
| MOLECULE_DEBUG |
There was a problem hiding this comment.
IIRC, rST docs suggest using definition lists for documenting variables. So this change does make sense. @ssbarnea Did doc8 suggest that change?
There was a problem hiding this comment.
Not really but when I reached the very long lines of that table, I found myself forced to fix that table bug.
doc8 is not as smart to do that.
- add doc8 linter - fixes newlines in rst - converts table to definition list to make it easier to read on narrow screens and also easier to maintain.
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
webknjaz
reviewed
Nov 10, 2021
|
|
||
| [doc8] | ||
| # see https://github.com/PyCQA/doc8/issues/75 | ||
| ignore-path = .eggs,.tox,constraints.txt,build,molecule.egg-info,src/molecule.egg-info |
There was a problem hiding this comment.
- I'd multiline this
- Isn't there a better config than package metadata?
There was a problem hiding this comment.
No multiline support, probably my comment should give you a hint that there is no much better place. FYI, flake is still inside setup.cfg for the same reasons.
ssbarnea
changed the title
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.
narrow screens and also easier to maintain.