docs(eslint-plugin): [prefer-readonly-parameter-types] fix invalid example (typescript-eslint#1791)

bradzacher · web-flow · commit b1b82847aa1d · 2020-03-23T16:06:15.000-07:00
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;

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,8 @@ function object3(arg: { readonly prop: { readonly prop2: string } }) {}`
`74`	`74`	`interface CustomArrayType extends ReadonlyArray<string> {`
`75`	`75`	`readonly prop: string;`
`76`	`76`	`}`
`77`		`-function custom1(arg: CustomArrayType) {}`
	`77`	`+function custom1(arg: Readonly<CustomArrayType>) {}`
	`78`	`+// interfaces that extend the array types are not considered arrays, and thus must be made readonly.`
`78`	`79`
`79`	`80`	`interface CustomFunction {`
`80`	`81`	`(): void;`