Skip to content

Trivial aliases. #9685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 5, 2017
Merged

Trivial aliases. #9685

merged 1 commit into from
Nov 5, 2017

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 4, 2017

colors.rgb2hex and colors.hex2color are trivial aliases of to_hex and
to_rgb.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer
Trivial aliases.
0cb3b36 
colors.rgb2hex and colors.hex2color are trivial aliases of to_hex and
to_rgb.
afvincent
afvincent approved these changes Nov 4, 2017
View reviewed changes
Copy link
Contributor

@afvincent afvincent left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Weren't the docstrings of these aliases functions quite deceptive anyway? hex2color('gray') as well as rgb2hex('gray') are working properly, despite what their docstrings suggested (and despite what their name still do, but that is another story...). At least with this patch the docstrings will be correct.

@dstansby
Copy link
Member

dstansby commented Nov 4, 2017

Hmm, these no longer appear in the documentation - is there any way to put them back?

@anntzer
Copy link
Contributor Author

anntzer commented Nov 4, 2017

They were intentionally removed from the docs in #6382.

@dopplershift dopplershift merged commit 901761c into matplotlib:master Nov 5, 2017
@anntzer anntzer deleted the trivial-aliases branch November 5, 2017 07:14
@QuLogic QuLogic added this to the v2.2 milestone Nov 5, 2017
@QuLogic QuLogic modified the milestones: needs sorting, v2.2.0 Feb 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dopplershift dopplershift dopplershift approved these changes

@afvincent afvincent afvincent approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.2.0
Development

Successfully merging this pull request may close these issues.
5 participants
@anntzer @dstansby @dopplershift @afvincent @QuLogic