docs: add no-deprecated-functions rule to README.md

jest-community · May 3, 2020 · dd7748a · dd7748a
1 parent b63c43e
commit dd7748a
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -115,6 +115,7 @@ installations requiring long-term consistency.
 | [lowercase-name][]             | Disallow capitalized test names                                   |                  | ![fixable-green][]  |
 | [no-alias-methods][]           | Disallow alias methods                                            | ![style][]       | ![fixable-green][]  |
 | [no-commented-out-tests][]     | Disallow commented out tests                                      | ![recommended][] |                     |
+| [no-deprecated-functions][]    | Disallow use of deprecated functions                              |                  | ![fixable-green][]  |
 | [no-disabled-tests][]          | Disallow disabled tests                                           | ![recommended][] |                     |
 | [no-duplicate-hooks][]         | Disallow duplicate hooks within a `describe` block                |                  |                     |
 | [no-expect-resolves][]         | Disallow using `expect().resolves`                                |                  |                     |
@@ -170,6 +171,7 @@ https://github.com/dangreenisrael/eslint-plugin-jest-formatting
 [lowercase-name]: docs/rules/lowercase-name.md
 [no-alias-methods]: docs/rules/no-alias-methods.md
 [no-commented-out-tests]: docs/rules/no-commented-out-tests.md
+[no-deprecated-functions]: docs/rules/no-deprecated-functions.md
 [no-disabled-tests]: docs/rules/no-disabled-tests.md
 [no-duplicate-hooks]: docs/rules/no-duplicate-hooks.md
 [no-expect-resolves]: docs/rules/no-expect-resolves.md

diff --git a/docs/rules/no-deprecated-functions.md b/docs/rules/no-deprecated-functions.md
@@ -1,4 +1,4 @@
-# Warns on usage of deprecated functions (no-deprecated-functions)
+# Disallow use of deprecated functions (no-deprecated-functions)
 
 Over the years Jest has accrued some debt in the form of functions that have
 either been renamed for clarity, or replaced with more powerful APIs.

diff --git a/src/rules/no-deprecated-functions.ts b/src/rules/no-deprecated-functions.ts
@@ -9,7 +9,7 @@ export default createRule({
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'Warns on usage of deprecated functions',
+      description: 'Disallow use of deprecated functions',
       recommended: false,
     },
     messages: {