DOC: improve tagging guidelines page #28527
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
story645
added
Documentation: devdocs
timhoffm
reviewed
Jul 9, 2024
timhoffm
reviewed
Jul 9, 2024
timhoffm
reviewed
Jul 9, 2024
story645
force-pushed
the
tag-guide
branch
2 times, most recently
from
37587bf
to
502fb6b
Compare
|
Attempted to address all the comments |
timhoffm
approved these changes
Jul 10, 2024
|
|
||
| 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 |
There was a problem hiding this comment.
Does sentence imply a full sentence including verb? Possible alternatives: expression, phrase ... (not a native speaker so cannot really judge)
add coding example move content guidelines to writing guide enable multiline Co-authored-by: Eva Sibinga <46283995+esibinga@users.noreply.github.com> Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
|
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
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Jul 12, 2024
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
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Jul 27, 2024
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
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
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.
Based on discussions w/ @esibing after #27235 and so it's improved for scipy sprints, cleaned up the tagging page so:
Also, thanks to @melissawm and melissawm/sphinx-tags#102
PR summary
PR checklist