Skip to content

Commit

Permalink
Move and rename "Accessibility concerns" section in CSS page templates (
Browse files Browse the repository at this point in the history
#34984)

* Move and rename accessibility section

Changes:
- Adjust section description for CSS Function and Property templates to match Selector template.
- Remove "optional" notice in favour of closing notice.

* Update description of Accessibility section in CSS page templates

As per: #34984 (comment)
  • Loading branch information
mcaskill committed Jul 31, 2024
1 parent 44d0a12 commit e3dd5fe
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ Not all functions have formal syntax: if a function doesn't, omit this whole sec

_To use this macro, remove the backticks and backslash in the markdown file._

## Accessibility

This is an optional section. Include accessibility guidelines, best practices, and potential concerns that developers should be aware of while using this property. You can also include workarounds or solutions where applicable.

## Examples

Note that we use the plural "Examples" even if the page only contains one example.
Expand Down Expand Up @@ -181,10 +185,6 @@ See our guide on how to add [code examples](/en-US/docs/MDN/Writing_guidelines/P
> For examples of this function, see [the page on basic-shape](https://example.org).
> ```
## Accessibility concerns
This is an optional section. You can include any warnings here for accessibility concerns that developers should be aware of while using this function. You can also include workarounds for these accessibility concerns if there are any.
## Specifications
`\{{Specifications}}`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ _To use this macro, remove the backticks and backslash in the markdown file._

_To use this macro, remove the backticks and backslash in the markdown file._

## Accessibility

This is an optional section. Include accessibility guidelines, best practices, and potential concerns that developers should be aware of while using this property. You can also include workarounds or solutions where applicable.

## Examples

Note that we use the plural "Examples" even if the page only contains one example.
Expand Down Expand Up @@ -164,10 +168,6 @@ See our guide on how to add [code examples](/en-US/docs/MDN/Writing_guidelines/P
> For examples of this API, see [the page on fetch()](https://example.org).
> ```
## Accessibility concerns
This is an optional section. You can include any warnings here for accessibility concerns that developers should be aware of while using this property. You can also include workarounds for these accessibility concerns if there are any.
## Specifications
`\{{Specifications}}`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ The summary paragraph — start by naming the selector and saying what it does.

_To use this macro, remove the backticks and backslash in the markdown file._

## Accessibility

This is an optional section. Include accessibility guidelines, best practices, and potential concerns that developers should be aware of while using this property. You can also include workarounds or solutions where applicable.

## Examples

Note that we use the plural "Examples" even if the page only contains one example.
Expand Down Expand Up @@ -131,11 +135,6 @@ See our guide on how to add [code examples](/en-US/docs/MDN/Writing_guidelines/P
> For examples of this API, see [the page on fetch()](https://example.org).
> ```
## Accessibility concerns
Optionally, warn of any potential accessibility concerns with using this selector and how to work around them.
Remove this section if there is no list.
## Specifications
`\{{Specifications}}`
Expand Down

0 comments on commit e3dd5fe

Please sign in to comment.