Simplify formatting of matplotlibrc.template. #15023
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
anntzer
force-pushed
the
rcstyle
branch
2 times, most recently
from
3cfb0df to
c1e4e2c
Compare
tacaswell
reviewed
Aug 11, 2019
There was a problem hiding this comment.
The wording at the top needs a bit of work, but overall 👍
Checked that this will still parse cleanly:
matplotlib/lib/matplotlib/__init__.py
Lines 893 to 903 in 49cec86
matplotlibrc.template
Outdated
| ## which case, four more whitespaces are preferred | ||
| ## Formatting: Use PEP8-like style (as enforced in the rest of the codebase), | ||
| ## except that all non-empty lines (whether including an rc entry or just | ||
| ## comments must start with an additional #. |
There was a problem hiding this comment.
Suggested change
| ## comments must start with an additional #. | |
| ## comments must start with an additional #). |
There was a problem hiding this comment.
I don't understand this sentence.
There was a problem hiding this comment.
reworded, does it sound better?
Having to specify formatting style conventions for matplotlibrc.template is a bit overkill. Just use normal PEP8 style: no spaces before colons, two spaces before inline comments, introduce comments with a single #. Also remove the note re: "editor with python syntax highlighting", given that the whole template appears as a long comment in Python so syntax highlighting buys nothing.
tacaswell
approved these changes
Feb 11, 2020
timhoffm
approved these changes
Feb 11, 2020
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.
Having to specify formatting style conventions for matplotlibrc.template
is a bit overkill. Just use normal PEP8 style: no spaces before colons,
two spaces before inline comments, introduce comments with a single #.
Also remove the note re: "editor with python syntax highlighting", given
that the whole template appears as a long comment in Python so syntax
highlighting buys nothing.
PR Summary
PR Checklist