Improve marker reference example description for clarity#31067
Improve marker reference example description for clarity#31067vidyanavghare08 wants to merge 5 commits intomatplotlib:mainfrom
Conversation
story645
left a comment
There was a problem hiding this comment.
Thanks, I think this is a bit clearer on the goals of this document. Some of the stuff that got deleted shouldn't have gotten deleted, and that needs to be fixed before this PR can be approved.
| - `Markers created from Paths`_ | ||
| The example demonstrates: | ||
|
|
||
| For a list of all markers see also the `matplotlib.markers` documentation. |
There was a problem hiding this comment.
This cross reference shouldn't be deleted, we want users to go to the full docs.
| For example usages see | ||
| :doc:`/gallery/lines_bars_and_markers/scatter_star_poly`. | ||
|
|
||
| .. redirect-from:: /gallery/shapes_and_collections/marker_path |
There was a problem hiding this comment.
Redirects can't be deleted, they're used to maintain old links.
| For example usages see | ||
| :doc:`/gallery/lines_bars_and_markers/scatter_star_poly`. |
There was a problem hiding this comment.
This could potentially be replaced by tags
https://matplotlib.org/devdocs/devel/tag_guidelines.html
| For a list of all markers see also the `matplotlib.markers` documentation. | ||
| - The difference between unfilled and filled markers | ||
| - How marker fill styles and colors can be changed | ||
| - Markers created using MathText symbols |
There was a problem hiding this comment.
| - Markers created using MathText symbols | |
| - Markers created using TeX symbols |
|
Thank you for the review. I have restored the removed cross-references and redirects, and updated the wording as suggested. |
story645
left a comment
There was a problem hiding this comment.
little nits but much better, thanks
| @@ -19,6 +23,7 @@ | |||
| .. redirect-from:: /gallery/shapes_and_collections/marker_path | |||
There was a problem hiding this comment.
small thing but can you move this to the top of the file?
| This example shows a visual overview of the different marker styles available | ||
| in Matplotlib and how they can be customized when plotting data. | ||
|
|
||
| - `Unfilled markers`_ | ||
| - `Filled markers`_ | ||
| - `Markers created from TeX symbols`_ | ||
| - `Markers created from Paths`_ | ||
| The example demonstrates: |
There was a problem hiding this comment.
| This example shows a visual overview of the different marker styles available | |
| in Matplotlib and how they can be customized when plotting data. | |
| - `Unfilled markers`_ | |
| - `Filled markers`_ | |
| - `Markers created from TeX symbols`_ | |
| - `Markers created from Paths`_ | |
| The example demonstrates: | |
| This example shows a visual overview of the different marker styles available | |
| in Matplotlib and how they can be customized when plotting data: |
don't need the extra line
| - Rotating and transforming markers | ||
| - Customizing marker cap styles and join styles | ||
|
|
||
| For a list of all markers see also the `matplotlib.markers` documentation. |
There was a problem hiding this comment.
| For a list of all markers see also the `matplotlib.markers` documentation. | |
| For a list of all markers, see the `matplotlib.markers` documentation. |
may as well clean up the grammar
|
Thanks for the suggestions! I’ve applied the requested changes. |
…g in marker_reference example
PR summary
This PR improves the introductory description of the marker reference example
to make it clearer for new users how markers can be selected and styled in plots.
This is a documentation/example clarity improvement only. There are no functional changes.
PR checklist