From 7ff2dfc144e9695896a56a569c6bd250c1a9f99a Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 10 Jul 2023 15:49:26 -0700 Subject: [PATCH] Include accessibility considerations in code annotation guidelines (#38835) --- contributing/code-annotations.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/contributing/code-annotations.md b/contributing/code-annotations.md index 4a91de1875..5bb75d87ab 100644 --- a/contributing/code-annotations.md +++ b/contributing/code-annotations.md @@ -8,6 +8,8 @@ For new users, code annotations are a way to go beyond the high level overview o For more experienced users, code annotations can help them understand a code example and then tailor it to their specific needs. Annotations can explain why code was written a certain way so that the fundamentals are clear. +You can annotate multiple code examples in a single article, but keep in mind that each annotation increases the complexity of an article and adds repetitive navigation tasks for people using screen readers. If you have multiple code examples in an article, consider whether they can be combined into a single example. + ## Enabling and adding code annotations 1. Specify the `layout: inline` frontmatter property for the article.