Add clarification of alt on img in docs
#692
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
Included `alt` as one of the attributes expected in the `img` component as this component outputs both and `alt` is what's most often/easily used when creating an image in markdown `[!alt](src "title")`. Removed parenthesis as it read better now that there wasn't just one item.
This comment has been minimized.
This comment has been minimized.
wooorm
reviewed
Jun 5, 2022
github-actions
bot
added
🤞 phase/open
This comment was marked as resolved.
This comment was marked as resolved.
wooorm
approved these changes
Jun 5, 2022
wooorm
changed the title
alt on img in docs
|
Thank you! |
This comment has been minimized.
This comment has been minimized.
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.
Initial checklist
Description of changes
Included
altas one of the attributes expected in theimgcomponent as this component outputs bothaltANDtitle. Not having both can be misleading specially sincealtis what's most often/easily used when creating an image in markdown[!alt](src "title"). The use of alt over title comes not only from practicality but also due to accessibility. Additionally, removed parenthesis as it read better now that there wasn't just one item.