Docs: fix reStructuredText
syntax for figures
#5386
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.
While reviewing some of our documentation PRs, I noticed that we use the
:alt:
(alternate text) syntax in a way that might be neither optimal nor consistent with thereStructuredText
figure examples:As a reminder, the
reStructuredText
image docs describes alternate text asBefore this PR, this is the output when an image is displayed:
Before this PR, this is the output when an image is not displayed (e.g., due to a typo in the docs):
After this PR, I would propose to have this output when an image is not displayed (e.g., due to a typo in the docs):
I think this is a better output for both users that read the docs (avoid reading the caption twice) and visually impaired users (avoid hearing the caption twice - the real caption is spoken too).
Note that in some cases we do not yet provide a caption. I believe we should add a caption to all figures, but I left this out of this PR.