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] Standardize deprecated rule notice #3364

Merged
merged 1 commit into from Aug 21, 2022

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Aug 21, 2022

❌ This rule is deprecated.
  • Standardize deprecation notice in rule docs to be more consistent with the other rule notices and add a test that it's present for deprecated rules. Note that rule-specific deprecation information is allowed at the end of the line for this notice.
  • In the README rules list, mention if a rule is deprecated next to its description. Note that I chose not to add a deprecation column like the other columns we have for recommended/fixable/suggestable because I didn't want to waste more horizontal width on this for something that is probably rare. We can always switch to a separate column in the future if needed.

Extracted from this PR: #3362

@codecov
Copy link

codecov bot commented Aug 21, 2022

Codecov Report

Merging #3364 (885afc3) into master (13d23b8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3364   +/-   ##
=======================================
  Coverage   97.54%   97.54%           
=======================================
  Files         123      123           
  Lines        8873     8873           
  Branches     3244     3244           
=======================================
  Hits         8655     8655           
  Misses        218      218           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@ljharb ljharb changed the title Standardize deprecated rule notice [Docs] Standardize deprecated rule notice Aug 21, 2022
@ljharb ljharb merged commit 885afc3 into jsx-eslint:master Aug 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants