Skip to content

[docs] codingstyle: Fix SQL indentation image alt text#1602

Open
travis-kuenzi wants to merge 1 commit into
moodle:mainfrom
travis-kuenzi:fix-sql-indentation-alt-text
Open

[docs] codingstyle: Fix SQL indentation image alt text#1602
travis-kuenzi wants to merge 1 commit into
moodle:mainfrom
travis-kuenzi:fix-sql-indentation-alt-text

Conversation

@travis-kuenzi
Copy link
Copy Markdown

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

  • Previewed the Markdown change in GitHub.
  • Confirmed the image reference still points to ./_sql/sql_indentation.png.
  • Confirmed the image alt text no longer uses the file name.
  • Confirmed a visible description appears below the image.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026

Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 67c0342
🔍 Latest deploy log https://app.netlify.com/projects/moodledevdocs/deploys/6a190a4625767500086ca67b
😎 Deploy Preview https://deploy-preview-1602--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@jrchamp
Copy link
Copy Markdown
Collaborator

jrchamp commented May 31, 2026

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Accessibility - SQL Indentation image alt text is the file name.

2 participants