[docs] codingstyle: Fix SQL indentation image alt text#1602
[docs] codingstyle: Fix SQL indentation image alt text#1602travis-kuenzi wants to merge 1 commit into
Conversation
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
I love this effort you've made. I do want to note that now that the text is duplicated, it will be read by a screen reader twice. "Visible" captions are my preference because they can highlight the purpose of the image in a way that might otherwise need to be inferred. To that end, I also encourage another word or two to clarify that the "vertical alignment" means uses spaces to horizontally align the last letter of these SQL keywords into the same vertical column. If that is already redundant with the surrounding text, then the image can delightfully become a redundant, functionally decorative, visual example of clear text-based documentation. |
Summary
Fixes #1395.
This PR updates the SQL coding style documentation by replacing the filename-based alt text for the SQL indentation image with a meaningful description. It also adds a visible text description below the image so the purpose of the image is available to all readers.
Testing
./_sql/sql_indentation.png.