-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Added Documentation on customizing color Sequences in Matplotlib #29554
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.
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
base: main
Are you sure you want to change the base?
Added Documentation on customizing color Sequences in Matplotlib #29554
Conversation
Looks like the text was added to the wrong file? It also looks like a "submodule" was accidentally added? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the potential contribution
This material can almost certainly not go on the main index page. There is already an entry for this in the Users Guide: https://matplotlib.org/stable/users/explain/artists/color_cycle.html Perhaps you would consider editing that in place, or finding a more suitable place for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR but besides the issues of location, these docs don't show the use of the color sequence registry and that is the issue that this new doc is intended to address.
My reading of #28750 is that this should be about using color_sequences, which do not seem to be mentioned here. @SHRISHTISHUKLA-0 if you are using AI to generate your changes, please read |
text I have added in index.rst |
as a example I linked this caused while running( make html )in terminal I got error |
If you are just trying to use our CI, please mark the PR as "Draft". I'm moving it to Draft now. |
Thank you for the feedback! |
Thank you for the clarification here |
Thanks for updating the PR status. My goal is to contribute meaningfully to the documentation rather than just using the CI. I appreciate the feedback and will refine my changes to better align with the documentation goals, particularly focusing on the color sequence registry as suggested. |
Yes, the PR will not even be considered for merging without this example
They serve different purposes and this PR should describe each one separately. But like @rcomer said, please explain what these are to show that you understand these concepts. |
btw Thank you for the feedback! I understand that this documentation should focus on using color_sequences. I will review the existing documentation and make the necessary adjustments to ensure it properly covers color_sequences and |
The content of this PR does not show that you understand color sequences because it at no point specifically talks about what the color sequences are, nor how to create or use them. Instead, these docs read like a generic mashup of existing documentation on color cyclers, which is why it reads like AI wrote it to @rcomer and me.
The document @jklymak linked seems fine as a start. |
PR adds missing documentation on color sequences in matplotlib , its make it easy for user as per my view to understand and apply them in their plots. currently as per my view matplotlib documentation lacks a dedicated section to explain how to use color sequences
.here solved problem
provide and also show how to define custom color sequences using cycler module and to apply color module in stylesheet I think through mplstyle files for styling.
mainly reason for this implementation as per me matplotlib provide the beginner-friendly documentation most importantly I will help user for leverage matplotlib styling
closes#28750
here documentation includes an explanation of color sequences and role
also demonstrate custom color cycles and style sheet
and I readed & made content follows matplotlibs documentation and there guidelines
hope so it will help to solve the issue if still there is something missing let me know.
thank you)