Add header from noxfile.py docstring #454 #459
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
This commit adds the functionality for using the `noxfile.py` module docstring as a header description for the `nox -l` option. The module docstring is now an attribute in `Manifest` which is now populated in `discover_manifest` which is in-turn passed to `honor_list_request` which will print the docstring if it is present, and do nothing if it is not present. I've also added two tests which cover these conditions (existent and non-existent module docstring) and added to an existing parametrized test.
cjolowicz
requested changes
Jul 2, 2021
|
By the way, sorry for the commit spam. I tried to be clever and merge in the upstream changes and got myself confused. Still fairly new to this! |
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.
This commit adds the functionality for using the
noxfile.pymoduledocstring as a header description for the
nox -loption. #454The module docstring is now an attribute in
Manifestwhich isnow populated in
discover_manifestwhich is in-turn passedto
honor_list_requestwhich will print the docstring if it ispresent, and do nothing if it is not present.
I've also added two tests which cover these conditions (existent and
non-existent module docstring) and added to an existing
parametrized test.