docs(return-await): remove return-await from recommended rules

drabinowitz · drabinowitz · commit 7fbe46b854e5 · 2019-11-24T19:29:35.000-05:00
return-await is not a recommended rule for users as part of default typescript-eslint setup. re typescript-eslint#994
diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
@@ -204,7 +204,7 @@ Then you should add `airbnb` (or `airbnb-base`) to your `extends` section of `.e
 | [`@typescript-eslint/require-await`](./docs/rules/require-await.md)                                       | Disallow async functions which have no `await` expression                                                                                           | :heavy_check_mark: |          | :thought_balloon: |
 | [`@typescript-eslint/restrict-plus-operands`](./docs/rules/restrict-plus-operands.md)                     | When adding two variables, operands must both be of type number or of type string                                                                   |                    |          | :thought_balloon: |
 | [`@typescript-eslint/restrict-template-expressions`](./docs/rules/restrict-template-expressions.md)       | Enforce template literal expressions to be of string type                                                                                           |                    |          | :thought_balloon: |
-| [`@typescript-eslint/return-await`](./docs/rules/return-await.md)                                     | Rules for awaiting returned promises                                                                                                   | :heavy_check_mark: |          | :thought_balloon: |
+| [`@typescript-eslint/return-await`](./docs/rules/return-await.md)                                         | Rules for awaiting returned promises                                                                                                                     |                  |          | :thought_balloon: |
 | [`@typescript-eslint/semi`](./docs/rules/semi.md)                                                         | Require or disallow semicolons instead of ASI                                                                                                       |                    | :wrench: |                   |
 | [`@typescript-eslint/space-before-function-paren`](./docs/rules/space-before-function-paren.md)           | enforce consistent spacing before `function` definition opening parenthesis                                                                         |                    | :wrench: |                   |
 | [`@typescript-eslint/strict-boolean-expressions`](./docs/rules/strict-boolean-expressions.md)             | Restricts the types allowed in boolean expressions                                                                                                  |                    |          | :thought_balloon: |
diff --git a/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.json b/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.json
@@ -10,7 +10,6 @@
     "@typescript-eslint/prefer-string-starts-ends-with": "error",
     "require-await": "off",
     "@typescript-eslint/require-await": "error",
-    "@typescript-eslint/return-await": "error",
     "@typescript-eslint/unbound-method": "error",
     "no-var": "error",
     "prefer-const": "error",
diff --git a/packages/eslint-plugin/src/rules/return-await.ts b/packages/eslint-plugin/src/rules/return-await.ts
@@ -12,7 +12,7 @@ export default util.createRule({
     docs: {
       description: 'Rules for awaiting returned promises',
       category: 'Best Practices',
-      recommended: 'error',
+      recommended: false,
       requiresTypeChecking: true,
     },
     type: 'problem',
