Have the --colored default value be yes in the docs #2289
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
gaborbernat
reviewed
Dec 20, 2021
docs/conf.py
Outdated
| nitpick_ignore = [] | ||
|
|
||
| # Force --colored default value to be yes. | ||
| os.environ["FORCE_COLOR"] = "yes" |
There was a problem hiding this comment.
can you put the command to the right-hand side here?
There was a problem hiding this comment.
Sorry I do not understand what you mean.
There was a problem hiding this comment.
os.environ["FORCE_COLOR"] = "yes" # ensure by default we documented coloredThere was a problem hiding this comment.
I see now (you wrote command instead of comment).
|
Is the changelog fragment really needed here? |
We can ignore that now. |
AntoineD
force-pushed
the
fix-doc-colored-default
branch
from
4fdc116 to
4b52615
Compare
gaborbernat
reviewed
Dec 20, 2021
docs/conf.py
Outdated
| nitpicky = True | ||
| nitpick_ignore = [] | ||
|
|
||
| os.environ["FORCE_COLOR"] = "yes" # Force --colored default value to be yes. |
There was a problem hiding this comment.
can you make the comment lowercase and remove the period? generally, I don't write it as a sentence unless there's multiple sentences
There was a problem hiding this comment.
Sure (I just tend to follow pep8 by default).
AntoineD
force-pushed
the
fix-doc-colored-default
branch
from
0bbf06e to
b7a39d3
Compare
for more information, see https://pre-commit.ci
gaborbernat
approved these changes
Dec 20, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixes #2288.