[Doc]: Add alt-text to images in 3.6 release notes #24844 #24878
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
| @@ -184,6 +189,7 @@ label entries, so this is best used when bars also differ in style (e.g., by | |||
| passing a list to *color*, as below.) | |||
|
|
|||
| .. plot:: | |||
| :alt: bar chart: blue bar height 10, orange bar height 20, green bar height 15 legend with blue box labeled a, orange box labeled b, and green box labeled c | |||
There was a problem hiding this comment.
| :alt: bar chart: blue bar height 10, orange bar height 20, green bar height 15 legend with blue box labeled a, orange box labeled b, and green box labeled c | |
| :alt: bar chart: blue bar height 10, orange bar height 20, green bar height 15; legend with blue box labeled a, orange box labeled b, and green box labeled c. |
There was a problem hiding this comment.
Should the numbers be spelled out here as well?
There was a problem hiding this comment.
I'm not sure that we have a specific style guide that specifies either way. I just know that the first word in the sentence is better spelled out. IIRC, for in-sentence numbers it's usually only for 'small' numbers, so these are probably too large.
There was a problem hiding this comment.
I think at some point we unofficially decided to use Google & their convention (& honestly the one I was always taught for technical writing) is that numerals are generally better when talking about measurable quantities. https://developers.google.com/style/numbers
There was a problem hiding this comment.
Thanks @hasanrashid ! Here are a few comments, but in general looks great!
…id/matplotlib into hasans-matplotlib/main
…id/matplotlib into hasans-matplotlib/main
Fixed indentation and type Blank line before directive
…id/matplotlib into hasans-matplotlib/main
|
These are minor typos; I would commit and squash-merge directly, but as you started from the protected |
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Squashed commit of the following: commit 015c997 Merge: b6400d2 6820797 commit b6400d2 Merge: 8b7f51c a30c0b1 commit 8b7f51c Merge: 7e42eaa f10d0d1 commit 7e42eaa commit 47e638b commit 2d17273 commit 02ad4ed commit 36638c8 commit 88f9e69 Merge: c310fab 11e37ac commit c310fab Merge: 3820d05 78f9c08 commit 3820d05 commit cd532aa commit 4ab0f52 commit 8d40c85 commit 447042f commit 1895995 commit adf6563 commit 34bbb24 Merge: a7dc972 651a874 commit a7dc972 Merge: 7547813 9a0b72a commit 7547813 commit d1dc422 commit 1503ed5 Merge: d3bf57d cb59251 commit cb59251 Merge: 9ffce62 ff17bc3 commit d3bf57d commit 9ffce62 Merge: 21a07fc ab6d190 commit 21a07fc commit ab6d190 Merge: cb03a55 d46628e commit cb03a55
jklymak
added
the
status: needs clarification
|
Moving to draft, feel free to move back |
QuLogic
removed
the
status: needs clarification
|
Thanks @hasanrashid! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again. Note that I squash merged this PR, as there is no need to keep the history in 30 separate commits. |
PR Summary
Added alt text for the plot images using the .plot. directive's .alt. option. This is the file that was edited: https://github.com/matplotlib/matplotlib/blob/main/doc/users/prev_whats_new/whats_new_3.6.0.rst. Some text came from Matplotlib's Twitter feed: https://twitter.com/matplotlib/status/1588567713034534913. https://heyzine.com/flip-book/f3c7f85cdc.html Was used as a guideline for writing alt text with accessibility in mind.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst