Skip to content
This repository has been archived by the owner on Jan 28, 2024. It is now read-only.

docs: regenerate rules documentation #5

Merged
merged 1 commit into from
Dec 11, 2023
Merged

docs: regenerate rules documentation #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ Rule 'rule-to-never-disable' should not be disabled. Explanation for why this is
<!-- prettier-ignore-start -->
<!-- begin auto-generated rules list -->

| Name | Description |
| :----------------------------------- | :---------------------------------------- |
| [rulesRule](docs/rules/rulesRule.md) | Completely bans disabling specific rules. |
| Name | Description |
| :--------------------------- | :---------------------------------------- |
| [rules](docs/rules/rules.md) | Completely bans disabling specific rules. |

<!-- end auto-generated rules list -->
<!-- prettier-ignore-end -->
Expand Down
10 changes: 5 additions & 5 deletions docs/rules/rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ Rules may be specified as an array of objects, each of which have the following

<!-- begin auto-generated rule options list -->

| Name | Type |
| :-------- | :------- |
| `message` | String |
| `rule` | String |
| `rules` | Object[] |
| Name | Description | Type |
| :-------- | :-------------------------------------- | :------- |
| `message` | Message to include in rule reports. | String |
| `rule` | Rule to disable, including plugin name. | String |
| `rules` | | Object[] |

<!-- end auto-generated rule options list -->
Loading