GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — DOC: improve tagging guidelines page by story645 · Pull Request #28527 · matplotlib/matplotlib

Conversation

@story645

@story645 story645 commented Jul 9, 2024

Copy link
Copy Markdown
Member

Based on discussions w/ @esibing after #27235 and so it's improved for scipy sprints, cleaned up the tagging page so:

  • list of categories pulls from glossary section headings so will remain in sync
  • added a code example of how to add tags
  • move content guidelines to writing guide -> I don't want/expect it to stay there, but think it's distracting here.

Also, thanks to @melissawm and melissawm/sphinx-tags#102

  • enable multiline

PR summary

PR checklist

  • "closes #0000" is in the body of the PR description to link the related issue
  • new and changed code is tested
  • Plotting related features are demonstrated in an example
  • New Features and API Changes are noted with a directive and release note
  • Documentation complies with general and docstring guidelines

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

melissawm reacted with hooray emoji
All reactions
  • 🎉 1 reaction
@story645 story645 added Documentation: devdocs files in doc/devel Documentation: tags tagging examples + proposing new tags labels Jul 9, 2024
timhoffm
timhoffm reviewed Jul 9, 2024
View reviewed changes
Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/_static/mpl.css Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

timhoffm
timhoffm reviewed Jul 9, 2024
View reviewed changes
Comment thread doc/_static/mpl.css Resolved

Uh oh!

There was an error while loading. Please reload this page.

timhoffm
timhoffm reviewed Jul 9, 2024
View reviewed changes
Comment thread doc/devel/tag_guidelines.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@story645
story645 force-pushed the tag-guide branch 2 times, most recently from 37587bf to 502fb6b Compare July 9, 2024 21:13
@story645

story645 commented Jul 9, 2024

Copy link
Copy Markdown
Member Author

Attempted to address all the comments

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@story645
story645 force-pushed the tag-guide branch from 502fb6b to dae8b54 Compare July 10, 2024 07:53
@github-actions github-actions Bot added the Documentation: build building the docs label Jul 10, 2024
timhoffm
timhoffm approved these changes Jul 10, 2024
View reviewed changes

@timhoffm timhoffm left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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.

Take or leave my comments. You can self-merge after that (and fixing the sphinx build).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

story645 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst

All :ref:`examples-index` should aim to follow these guidelines:

:Title: Describe content in a short sentence (approx. 1-6 words). Do not use *demo* as

@timhoffm timhoffm Jul 10, 2024

Copy link
Copy Markdown
Member

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.

Does sentence imply a full sentence including verb? Possible alternatives: expression, phrase ... (not a native speaker so cannot really judge)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/devel/document.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/_static/mpl.css Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/_static/mpl.css Resolved

Uh oh!

There was an error while loading. Please reload this page.

story645 and others added 3 commits July 11, 2024 05:12
@story645
added removed tags from make clean
33fa773
@story645 @esibinga @timhoffm
use glossery headings for category listings
837650d
add coding example
move content guidelines to writing guide
enable multiline

Co-authored-by: Eva Sibinga <[email protected]>
Co-authored-by: Tim Hoffmann <[email protected]>
@story645
fixing tags
214a6ec
@story645
story645 force-pushed the tag-guide branch from dae8b54 to 214a6ec Compare July 11, 2024 09:12
@story645
story645 merged commit 48c8f07 into matplotlib:main Jul 11, 2024
@story645

story645 commented Jul 11, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member Author

Thanks, self merged after addressing the comments so this would be live for when we advertise tagging next session, but will totally make a follow up if anyone has feedback.

timhoffm reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@QuLogic QuLogic added this to the v3.10.0 milestone Jul 12, 2024
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Jul 12, 2024
@timhoffm
DOC: Standardize example titles
55a993e
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.
@timhoffm timhoffm mentioned this pull request Jul 12, 2024
DOC: Standardize example titles #28544
Merged
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Jul 27, 2024
@timhoffm @story645
DOC: Standardize example titles
eecc0a0
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 <[email protected]>
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 1, 2024
@timhoffm
DOC: Standardize example titles - part 2
48f87a7
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 timhoffm mentioned this pull request Aug 1, 2024
DOC: Standardize example titles - part 2 #28641
Merged
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Aug 1, 2024
@timhoffm
DOC: Standardize example titles - part 2
520dd95
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
@timhoffm
DOC: Standardize example titles - part 2
af9f872
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
@timhoffm
DOC: Standardize example titles - part 2
c6cf03f
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
@timhoffm
DOC: Standardize example titles - part 2
5cf1437
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
@timhoffm @story645
DOC: Standardize example titles - part 2
a4e9e07
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 <[email protected]>
@timhoffm timhoffm mentioned this pull request Feb 6, 2025
What does a 'perfect' MPL example look like? #6221
Closed
@story645 story645 mentioned this pull request Feb 2, 2026
[DOC]: usage docs content guidelines #26389
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timhoffm timhoffm timhoffm approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

Documentation: build building the docs Documentation: devdocs files in doc/devel Documentation: tags tagging examples + proposing new tags

Projects

None yet

Milestone

v3.10.0

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@story645 @timhoffm @QuLogic
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.