Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: greater consistency of help / description text #3204

Merged
merged 3 commits into from Oct 14, 2021

Conversation

WilcoFiers
Copy link
Contributor

Improve consistency of help and description texts by:

  • Using "must" or "should" in help texts
  • Starting descriptions with the word "ensure"
  • Write tag names with <angel-brackets>
  • Keep help texts shorter than the descriptions

Closes issue: #3175

@WilcoFiers WilcoFiers requested a review from a team as a code owner October 13, 2021 11:59
lib/rules/focus-order-semantics.json Outdated Show resolved Hide resolved
lib/rules/nested-interactive.json Outdated Show resolved Hide resolved
lib/rules/no-autoplay-audio.json Outdated Show resolved Hide resolved
Co-authored-by: Steven Lambert <2433219+straker@users.noreply.github.com>
Co-authored-by: Glenda Sims <goodwitch@users.noreply.github.com>
@WilcoFiers WilcoFiers merged commit 0677565 into develop Oct 14, 2021
@WilcoFiers WilcoFiers deleted the consistent-help-text branch October 14, 2021 07:22
straker added a commit that referenced this pull request Oct 18, 2021
* fix: greater consistency of help / description text

* Apply suggestions from code review

Co-authored-by: Steven Lambert <2433219+straker@users.noreply.github.com>

* Update lib/rules/p-as-heading.json

Co-authored-by: Glenda Sims <goodwitch@users.noreply.github.com>

Co-authored-by: Steven Lambert <2433219+straker@users.noreply.github.com>
Co-authored-by: Glenda Sims <goodwitch@users.noreply.github.com>
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.

None yet

3 participants