docs(eslint-plugin): [prefer-readonly-parameter-types] fix invalid ex…

…ample (#1791)
typescript-eslint · Mar 23, 2020 · b1b8284 · b1b8284
1 parent 258fdd0
commit b1b8284
Showing 1 changed file with 2 additions and 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
@@ -74,7 +74,8 @@ function object3(arg: { readonly prop: { readonly prop2: string } }) {}
 interface CustomArrayType extends ReadonlyArray<string> {
   readonly prop: string;
 }
-function custom1(arg: CustomArrayType) {}
+function custom1(arg: Readonly<CustomArrayType>) {}
+// interfaces that extend the array types are not considered arrays, and thus must be made readonly.
 
 interface CustomFunction {
   (): void;