Skip to content

Improve marker reference example description for clarity#31067

Open
vidyanavghare08 wants to merge 5 commits intomatplotlib:mainfrom
vidyanavghare08:main
Open

Improve marker reference example description for clarity#31067
vidyanavghare08 wants to merge 5 commits intomatplotlib:mainfrom
vidyanavghare08:main

Conversation

@vidyanavghare08
Copy link

@vidyanavghare08 vidyanavghare08 commented Feb 3, 2026

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

  • [N/A] closes #0000
  • [N/A] new and changed code is tested
  • [N/A] Plotting related features are demonstrated in an example
  • [N/A] New Features and API Changes are noted with a directive and release note
  • Documentation complies with general and docstring guidelines

@github-actions github-actions bot added the Documentation: examples files in galleries/examples label Feb 3, 2026
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

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.
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

Redirects can't be deleted, they're used to maintain old links.

Comment on lines 16 to 17
For example usages see
:doc:`/gallery/lines_bars_and_markers/scatter_star_poly`.
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Markers created using MathText symbols
- Markers created using TeX symbols

@vidyanavghare08
Copy link
Author

Thank you for the review. I have restored the removed cross-references and redirects, and updated the wording as suggested.

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

little nits but much better, thanks

@@ -19,6 +23,7 @@
.. redirect-from:: /gallery/shapes_and_collections/marker_path
Copy link
Member

Choose a reason for hiding this comment

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

small thing but can you move this to the top of the file?

Comment on lines 6 to 9
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:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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

@vidyanavghare08
Copy link
Author

Thanks for the suggestions! I’ve applied the requested changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: examples files in galleries/examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants