Alt text for documentation #5226
Merged
Conversation
This file contains hidden or 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
thomasp85
approved these changes
Mar 13, 2023
There was a problem hiding this comment.
LGTM. @batpigandme can I get you to look quickly through this and confirm that this format is the right one for alt text when it comes to helping out readers with vision impairment?
batpigandme
approved these changes
Mar 15, 2023
| @@ -265,6 +319,11 @@ The [**scales**](https://scales.r-lib.org/) package offers a large number of fun | |||
| Use `scales::label_number()` to force decimal display of numbers rather than using scientific notation or use `scales::label_comma()` to insert a comma every three digits. | |||
|
|
|||
| ```{r} | |||
| #| fig.alt = "A scatter plot showing the median sale price of housing in Texas | |||
| #| on the x-axis and the total volume of sales on the y-axis. The labels of | |||
| #| the y-axis are written out in full, with commas marking groups of three | |||
There was a problem hiding this comment.
Suggested change
| #| the y-axis are written out in full, with commas marking groups of three | |
| #| the y-axis labels are written out in full, with commas marking groups of three |
There was a problem hiding this comment.
The labels are mentioned in the line above, so I think we're safe for now :)
Co-authored-by: Mara Averick <[email protected]>
|
Thanks for the thorough review, helpful suggestions and kind words @batpigandme! I apologise for the spelling mistake that got copied over a few times. With the exception of the change 'The labels of the y-axis are written out in full' --> 'The labels of the y-axis labels are written out in full', I've accepted all the suggestions. |
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.
This PR aims to fix #5222.
Briefly it adds alt text to plots in the readme, vignettes and articles. I tried to structure alt text for plots in the following way:
Because the docs are structured a lot along the lines 'here is a basic plot that we'll modify in various ways', a lot of repetition occurs in describing what is being plotted. I don't know if this repetition is preferred or not by the target audience of alt text. Instead of this repetition, one could alternatively describe 'as the previous plot, but with the following changes'.