-
Notifications
You must be signed in to change notification settings - Fork 33
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
Add alt text to blog posts #71
Conversation
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.
Thank you for this work 🚀 I have a few suggestions. Also it seems like you inadvertently updated the theme, this should be reverted (it will resolve the merge conflict).
![Graph showing relationship between velocity and time for a free-falling object.](figure/just-velocity.png) | ||
|
||
<div class="image-caption"> | ||
<b>Fig. 1.2</b> Velocity is increasing in fixed steps, due to a "constant" acceleration. |
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.
Here and above there was already a caption. I think in this case, both descriptions could be joined: the former captions had more details about how to interpret the figure.
In any case we should only retain a single caption.
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.
@isabela-pf I took care of the merge conflict and merged @tupui other suggestion. But, I wasn't sure what to do about this. I am happy make the change, if you could let me know what you think about merging the caption and alt-text. More generally, is alt-text needed when there is a detailed caption? If so, how do you decide what goes in the caption and what does in the alt-text?
Thanks for all your and @MarsBarLee's help with this!
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.
Thanks for catching this @tupui, it's really important!
How it is now
I ran a screen reader (VoiceOver for me) over the above area's images (as they are now, with png
as alt text) and captions and found that they are read as
- When focus is on image: "png, image"
- When focus is on caption: The caption is read like all other text, so in this case "Fig. 1.2…"
So in order, I get "png, image. Figure 1.2…" The captions are actually pretty good, so this isn't terrible but makes it unclear if the reader is missing information in this mystery image.
What I suggested
I've added suggestions to label the images as their figure title so that it reads as "Fig. 1.2, image. Fig. 1.2 Velocity is increasing…" That may be redundant, but I think it makes it clear that the image is fully described by the following caption.
If you have another idea, feel free to work with that; I'm happy to test it out. And thank you so so much for help with the merge conflict @jarrodmillman!
Co-authored-by: MarsBarLee <46167686+MarsBarLee@users.noreply.github.com> Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com> Co-authored-by: Saranjeet Kaur <kaur.saranjeet3@gmail.com> Co-authored-by: Mridul Seth <mail@mriduls.com> Co-authored-by: Max Grover <mgroverwx@gmail.com> Co-authored-by: Ricardo Prins <ricardoprins@gmail.com> Co-authored-by: Noa Tamir <6564007+noatamir@users.noreply.github.com> Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com> Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
Co-authored-by: Pamphile Roy <roy.pamphile@gmail.com>
e96e9e3
to
06efb20
Compare
content/posts/matplotlib/pyplot-vs-object-oriented-interface/index.md
Outdated
Show resolved
Hide resolved
content/posts/matplotlib/pyplot-vs-object-oriented-interface/index.md
Outdated
Show resolved
Hide resolved
Pinging everyone here to check if my proposed changes are okay and if there's any other feedback I need to address! |
Co-authored-by: Isabela Presedo-Floyd <50221806+isabela-pf@users.noreply.github.com>
Thank you everyone. This was a great initiative with a perfect execution 🚀 |
Thank you for the feedback and following up! 🌻 |
pngquant
.Addresses but does not totally address #33.
I'm not sure where the theme changes were picked up in this process or how to fix them, so guidance there would be greatly appreciated.
This PR adds or updates existing alt text across multiple blog posts. Full disclosure, there are still images in this repo in need of alt text. But this is a great start! We'll hopefully be back to address more in the future.
If you have any questions about reviewing alt text, let me know and I'd be happy to tell you what I review for.
Thanks in advance for reviewing this PR! 🌻
This alt text was contributed by wonderful volunteers at the recent alt text workshop! They teamed up to make this awesome PR. If you are curious about any discussion around these contributions, feel free to check out our working PR.
(And a big shout out to @MarsBarLee in particular for leading this workshop and doing all the set up for this PR. I am merely the messenger.)