Undeprecate case-insensitive "long" colornames. #13376
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
timhoffm
reviewed
Feb 6, 2019
| @@ -66,7 +66,7 @@ def setup(ax): | |||
| # Index Locator | |||
| ax = plt.subplot(n, 1, 5) | |||
| setup(ax) | |||
| ax.plot(range(0, 5), [0]*5, color='white') | |||
| ax.plot(range(0, 5), [0]*5, color='White') | |||
There was a problem hiding this comment.
I would leave basic color words lowercase, even though they are case-insensitive. Seems more natural and common.
https://www.w3.org/TR/css-color-3/ Section 4.1. Basic color keywords
lib/matplotlib/colors.py
Outdated
| or ``(0.1, 0.2, 0.5, 0.3)``); | ||
| * a hex RGB or RGBA string (e.g., ``'#0F0F0F'`` or ``'#0F0F0F0F'``); | ||
| or ``(0.1, 0.2, 0.5, 0.3)``); | ||
| * a hex RGB or RGBA string (e.g., ``'#0F0F0F'`` or ``'#0f0f0f0f'``); |
There was a problem hiding this comment.
Suggested change
| * a hex RGB or RGBA string (e.g., ``'#0F0F0F'`` or ``'#0f0f0f0f'``); | |
| * a hex RGB or RGBA string (e.g., ``'#0f0f0f'`` or ``'#0f0f0f80'``); |
- I would not change the case when actually showcasing the difference between RGB and RGBA. That's distracting from the original purpose.
- I recommend to use a different value for alpha than the RGB values. While #0f0f0f is common it's unlikely that the alpha value would be the same, this makes the example more realistic and easier to understand. You may add an additional note that the string is case insensitive.
- [minor] I have a slight preference for lowercase hex color values. HTML5 specifies "valid simple color" and the specialization valid lowercase simple color - but not an uppercase simple color. This indicates that lowercase is more important, also it's the standard for serializing color values in HTML5. Another hint is that some random thread on RGB case mentions the lowercase variant twice as often.
lib/matplotlib/colors.py
Outdated
| "removed %(removal)s.") | ||
| if len(c) == 1: | ||
| cbook.warn_deprecated( | ||
| "3.1", message="Support for case-insensitive " |
There was a problem hiding this comment.
Suggested change
| "3.1", message="Support for case-insensitive " | |
| "3.1", message="Support for uppercase " |
'+ Please use lowercase instead.
tutorials/colors/colors.py
Outdated
| * a hex RGB or RGBA string (e.g., ``'#0F0F0F'`` or ``'#0F0F0F0F'``); | ||
| * an RGB or RGBA (red, green, blue, alpha) tuple of float values in ``[0, 1]`` | ||
| (e.g., ``(0.1, 0.2, 0.5)`` or ``(0.1, 0.2, 0.5, 0.3)``); | ||
| * a hex RGB or RGBA string (e.g., ``'#0F0F0F'`` or ``'#0f0f0f0f'``); |
CSS colors are case-insensitive (and typically given in CamelCase in CSS) so making them case-sensitive seems less than optimal and likely causes some pointless churn. Revert some corresponding changes in examples. Only keep the deprecation for single-letter colors, which are likely rarely given in uppercase (`plt.plot([1, 2], "Yo")` never worked and no one ever complained) and for which the rationale given in the changelog (collision with data-kwarg keys) remains valid. Update the docs to explicitly mention case-sensitivity.
d11b55f to
4d26d3f
Compare
jklymak
approved these changes
Feb 6, 2019
timhoffm
approved these changes
Feb 6, 2019
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.
CSS colors are case-insensitive (and typically given in CamelCase in
CSS) so making them case-sensitive seems less than optimal and likely
causes some pointless churn. Revert some corresponding changes in
examples.
Only keep the deprecation for single-letter colors, which are likely
rarely given in uppercase (
plt.plot([1, 2], "Yo")never worked andno one ever complained) and for which the rationale given in the
changelog (collision with data-kwarg keys) remains valid.
Update the docs to explicitly mention case-sensitivity.
Partially reverts #13211; reverts #13227.
Sorry for the change of mind...
Milestoning as RC 3.1 to avoid the spurious deprecation warning.
PR Summary
PR Checklist