Skip to content

DOC: Standardize example titles #28544

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

Merged
merged 1 commit into from
Jul 27, 2024
Merged

Conversation

timhoffm
Copy link
Member

Following recommendatinos from #28527, this improves example titles. Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.

@github-actions github-actions bot added the Documentation: examples files in galleries/examples label Jul 12, 2024
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 for doing such a large batch! Small comments on a couple of titles, I hope.

MATPLOTLIB **UNCHAINED**
========================
====================
Matplotlib unchained
Copy link
Member

Choose a reason for hiding this comment

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

This is fun and not at all descriptive :/

Copy link
Member Author

Choose a reason for hiding this comment

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

I have no better name and don't know if anybody feels strongly about this particular title. So I've just removed the special formatting.

Zoom Window
===========
========================
Zoom modifies other Axes
Copy link
Member

Choose a reason for hiding this comment

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

would folks recognize `brushing-linking w/ zoom" or too jargony?

If jargony, then this brush-link should be added in tags at some point and maybe in the discription

Copy link
Member Author

Choose a reason for hiding this comment

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

"brushing-linking" does not tell me anything :/

Copy link
Member

Choose a reason for hiding this comment

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

sounds like it's a good candidate for a tag then, rather than a title. https://infovis-wiki.net/wiki/Linking_and_Brushing

Zoom Window
===========
========================
Zoom modifies other Axes
Copy link
Member Author

Choose a reason for hiding this comment

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

"brushing-linking" does not tell me anything :/

@timhoffm timhoffm force-pushed the doc-example-titles branch from 397c0a1 to 4a64f04 Compare July 25, 2024 18:33
@story645
Copy link
Member

story645 commented Jul 26, 2024

Can self merge after rebase and working doc build.

Following recommendatinos from matplotlib#28527, this improves example titles.
Take this as an incremental improvement. I've changed what I saw at a
glance when going through the examples once. Certainly, one could do
further improvements, but that can be done in follow-ups.

Co-authored-by: hannah <story645@gmail.com>
@timhoffm timhoffm force-pushed the doc-example-titles branch from 4a64f04 to eecc0a0 Compare July 27, 2024 21:03
@timhoffm timhoffm merged commit efeb823 into matplotlib:main Jul 27, 2024
22 checks passed
@timhoffm timhoffm deleted the doc-example-titles branch July 27, 2024 21:26
@QuLogic QuLogic added this to the v3.10.0 milestone Jul 29, 2024
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 1, 2024
Follow up to matplotlib#28544. As there:

Following recommendations from matplotlib#28527, this improves example titles.
Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 1, 2024
Follow up to matplotlib#28544. As there:

Following recommendations from matplotlib#28527, this improves example titles.
Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 1, 2024
Follow up to matplotlib#28544. As there:

Following recommendations from matplotlib#28527, this improves example titles.
Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 1, 2024
Follow up to matplotlib#28544. As there:

Following recommendations from matplotlib#28527, this improves example titles.
Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 2, 2024
Follow up to matplotlib#28544. As there:

Following recommendations from matplotlib#28527, this improves example titles.
Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 2, 2024
Follow up to matplotlib#28544. As there:

Following recommendations from matplotlib#28527, this improves example titles.
Take this as an incremental improvement. I've changed what I saw  t a
glance when going through the examples once. Certainly, one could do
further improvements, but that can be done in follow-ups.

Co-authored-by: hannah <story645@gmail.com>
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 Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants