docs(scss): improve color-contrast function documentation#42055
Open
docs(scss): improve color-contrast function documentation#42055
Conversation
Added comprehensive documentation for the color contrast functions: - Explained WCAG 2.2 contrast requirements - Added contrast level reference (AA vs AAA) - Documented function parameters with SassDoc-style comments - Added links to WCAG guidelines This helps developers understand the accessibility implications of the contrast calculations and choose appropriate values.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Improved documentation for the
color-contrast(),contrast-ratio(), andluminance()functions in_functions.scss.Changes
Added WCAG 2.2 Reference
Added SassDoc-style Function Documentation
@paramdescriptions for all function parameters@returntype documentationMotivation
The color contrast functions are critical for accessibility compliance, but the existing documentation did not explain the WCAG requirements or how the
$min-contrast-ratioparameter relates to accessibility levels.This additional documentation helps developers:
WCAG Reference
See: https://www.w3.org/WAI/WCAG22/Understanding/contrast-minimum.html