Skip to content

Review: Should we add fix comments to the @break comments? #107

@lsr-explore

Description

@lsr-explore

Should fixes be documents?

It might be helpful to document the fixes so they can be used to help provide a recommended fix.
e.g. A user may decide to add a screen reader only text to a button that is an icon instead of adding aria-label.

https://github.com/accessiblecommunity/fixable/pull/96/changes#diff-be961b3cef9fdaa878157eb4d1ec78d1f8dbb0566de5d3e2f71224b2c0c43e0bR46

 /**
         * @break
         * wcag2: 1.1.1
         * wcag3: Image alternatives available
         * description: The arrow buttons over the map do not contain text labels.
         * fix:
         *     descripiton: Added aria-label attribute to each button
         *
  **/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions