Skip to content

docs(eslint-plugin): [parameter-properties] improve docs #4927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 10, 2022
Merged

docs(eslint-plugin): [parameter-properties] improve docs #4927

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
525961a
docs: correct doc of parameter-properties to match the code
miZyind May 9, 2022
e3fd14e
docs: revert mistake
miZyind May 9, 2022
575a830
docs: correct invalid options
miZyind May 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions packages/eslint-plugin/docs/rules/parameter-properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ It may take an options object containing either or both of:

### `"allow"`

If you would like to ignore certain kinds of properties then you may pass an object containing `"allows"` as an array of any of the following options:
If you would like to ignore certain kinds of properties then you may pass an object containing `"allow"` as an array of any of the following options:

- `allows`, an array containing one or more of the allowed modifiers. Valid values are:
- `allow`, an array containing one or more of the allowed modifiers. Valid values are:
- `readonly`, allows **readonly** parameter properties.
- `private`, allows **private** parameter properties.
- `protected`, allows **protected** parameter properties.
Expand Down Expand Up @@ -102,7 +102,7 @@ class Foo {

### readonly

Examples of code for the `{ "allows": ["readonly"] }` options:
Examples of code for the `{ "allow": ["readonly"] }` options:

<!--tabs-->

Expand Down Expand Up @@ -148,7 +148,7 @@ class Foo {

### private

Examples of code for the `{ "allows": ["private"] }` options:
Examples of code for the `{ "allow": ["private"] }` options:

<!--tabs-->

Expand Down Expand Up @@ -194,7 +194,7 @@ class Foo {

### protected

Examples of code for the `{ "allows": ["protected"] }` options:
Examples of code for the `{ "allow": ["protected"] }` options:

<!--tabs-->

Expand Down Expand Up @@ -240,7 +240,7 @@ class Foo {

### public

Examples of code for the `{ "allows": ["public"] }` options:
Examples of code for the `{ "allow": ["public"] }` options:

<!--tabs-->

Expand Down Expand Up @@ -286,7 +286,7 @@ class Foo {

### private readonly

Examples of code for the `{ "allows": ["private readonly"] }` options:
Examples of code for the `{ "allow": ["private readonly"] }` options:

<!--tabs-->

Expand Down Expand Up @@ -332,7 +332,7 @@ class Foo {

### protected readonly

Examples of code for the `{ "allows": ["protected readonly"] }` options:
Examples of code for the `{ "allow": ["protected readonly"] }` options:

<!--tabs-->

Expand Down Expand Up @@ -378,7 +378,7 @@ class Foo {

### public readonly

Examples of code for the `{ "allows": ["public readonly"] }` options:
Examples of code for the `{ "allow": ["public readonly"] }` options:

<!--tabs-->

Expand Down Expand Up @@ -422,9 +422,9 @@ class Foo {
}
```

### `"parameter-properties"`
### `"parameter-property"`

Examples of code for the `{ "prefer": ["parameter-properties"] }` option:
Examples of code for the `{ "prefer": "parameter-property" }` option:

<!--tabs-->

Expand Down