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

docs: rule readme harmonization #197

Merged

Conversation

MikeMcC399
Copy link
Collaborator

Issues

This PR deals with the README > Rules section.

  1. The rule descriptions do not agree with the lib/rules property meta.docs.description.
  2. The rules are only sorted according to inclusion in the recommended set. Otherwise there is no recognizable sorting order.
  3. The entry for no-async-before is missing (part of issue cypress/no-async-before rule documentation issues #193)

Changes

  1. The rule table is formatted and populated according to the standard derived from the eslint-doc-generator
  2. The rule descriptions are a direct copy of the meta.docs.description property from the corresponding lib/rules source.
  3. Entries for all 9 rules are listed.
  4. The rules are sorted alphabetically.
  5. The README > Rules section is prepared for auto-generated content.

AFTER

image

@cypress-app-bot
Copy link

@MikeMcC399
Copy link
Collaborator Author

@MikeMcC399 MikeMcC399 marked this pull request as ready for review April 29, 2024 07:31
@jennifer-shehane jennifer-shehane merged commit 233d62c into cypress-io:master Apr 29, 2024
6 checks passed
@MikeMcC399 MikeMcC399 deleted the rule-readme-harmonization branch April 29, 2024 14:05
@cypress-app-bot
Copy link

🎉 This PR is included in version 3.0.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants