From b1b82847aa1db5040b18daf7b601f9c63c96a99c Mon Sep 17 00:00:00 2001 From: Brad Zacher Date: Mon, 23 Mar 2020 16:06:15 -0700 Subject: [PATCH] docs(eslint-plugin): [prefer-readonly-parameter-types] fix invalid example (#1791) --- .../docs/rules/prefer-readonly-parameter-types.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md b/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md index c69b3b21c34..74697f2d3e6 100644 --- a/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md +++ b/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md @@ -74,7 +74,8 @@ function object3(arg: { readonly prop: { readonly prop2: string } }) {} interface CustomArrayType extends ReadonlyArray { readonly prop: string; } -function custom1(arg: CustomArrayType) {} +function custom1(arg: Readonly) {} +// interfaces that extend the array types are not considered arrays, and thus must be made readonly. interface CustomFunction { (): void;