8000 DOC: Added exported colors to colors.api by MikiPWata · Pull Request #25574 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: Added exported colors to colors.api #25574

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
Mar 30, 2023
Merged

DOC: Added exported colors to colors.api #25574

merged 1 commit into from
Mar 30, 2023
+14 −0

Conversation

MikiPWata
Copy link
@MikiPWata MikiPWata commented Mar 29, 2023 •
edited
Loading

PR Summary

closes #25521

  • documented exported colors array in colors.api

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@tacaswell tacaswell added this to the v3.7-doc milestone Mar 29, 2023
@tacaswell
Copy link
Member

image

Looks good!

@tacaswell
Copy link
Member

@MikiPWata Do you think it is worth adding a note that these are dictionaries mapping names -> hex values as strings?

@MikiPWata
Copy link
Author
MikiPWata commented Mar 29, 2023 •
edited
Loading

@MikiPWata Do you think it is worth adding a note that these are dictionaries mapping names -> hex values as strings?

yes, I think it would be helpful, and it might be even better if I add a reference to https://matplotlib.org/devdocs/gallery/color/named_colors.html
as well.... should I?
@tacaswell

@tacaswell
Copy link
Member

Yes please! You can keep pushing commits to this branch and it will automatically update.

@MikiPWata MikiPWata requested a review from tacaswell March 30, 2023 01:00
tacaswell
tacaswell reviewed Mar 30, 2023
View reviewed changes
doc/api/colors_api.rst Outdated
Exported colors
---------------

.. note::
Copy link
Member
@tacaswell tacaswell Mar 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I don't think this needs to be in a note, can can just be normal prose.

Maybe something like

The data used to populate the :ref:named colors is exposed as dictionaries that map color name to hex string

?

Copy link
Author

Choose a reason for hiding this comment

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

Got it!

@MikiPWata MikiPWata requested a review from tacaswell March 30, 2023 01:35
@MikiPWata
Copy link
Author

I will squash all the commit once it's good to go

QuLogic
QuLogic reviewed Mar 30, 2023
View reviewed changes
Copy link
Member
@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

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

LGTM otherwise; feel free to squash.

@MikiPWata MikiPWata force-pushed the DOC/exported_colors branch from 04d7692 to 9f5f8c4 Compare March 30, 2023 05:30
@MikiPWata MikiPWata requested review from QuLogic and removed request for tacaswell March 30, 2023 05:31
@QuLogic QuLogic merged commit e240080 into matplotlib:main Mar 30, 2023
@QuLogic
Copy link
Member
QuLogic commented Mar 30, 2023

Thanks @MikiPWata! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again.

@meeseeksmachine meeseeksmachine mentioned this pull request Mar 30, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 30, 2023
@QuLogic @meeseeksmachine
Backport PR matplotlib#25574: DOC: Added exported colors to colors.api
674a2fd
@meeseeksmachine meeseeksmachine mentioned this pull request Mar 30, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 30, 2023
@QuLogic @meeseeksmachine
Backport PR matplotlib#25574: DOC: Added exported colors to colors.api
f8aaf4d
QuLogic added a commit that referenced this pull request Mar 30, 2023
@QuLogic
Merge pull request #25579 from meeseeksmachine/auto-backport-of-pr-25…
d57c878 
…574-on-v3.7.1-doc

Backport PR #25574 on branch v3.7.1-doc (DOC: Added exported colors to colors.api)
QuLogic added a commit that referenced this pull request Mar 30, 2023
@QuLogic
Merge pull request #25578 from meeseeksmachine/auto-backport-of-pr-25…
94b73b8 
…574-on-v3.7.x

Backport PR #25574 on branch v3.7.x (DOC: Added exported colors to colors.api)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

@Qu 5BDF Logic QuLogic QuLogic approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.7-doc
Development

Successfully merging this pull request may close these issues.

[Doc]: TABLEAU_COLORS XKCD_COLORS etc undocumented
3 participants
@MikiPWata @tacaswell @QuLogic
0