From 863b8c628da2d34e153949249b3e05118949deec Mon Sep 17 00:00:00 2001 From: StyleShit Date: Mon, 11 Dec 2023 08:58:02 +0200 Subject: [PATCH] docs: regenerate rules documentation --- README.md | 6 +++--- docs/rules/rules.md | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4733fb6..41829c7 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ Rule 'rule-to-never-disable' should not be disabled. Explanation for why this is -| Name | Description | -| :----------------------------------- | :---------------------------------------- | -| [rulesRule](docs/rules/rulesRule.md) | Completely bans disabling specific rules. | +| Name | Description | +| :--------------------------- | :---------------------------------------- | +| [rules](docs/rules/rules.md) | Completely bans disabling specific rules. | diff --git a/docs/rules/rules.md b/docs/rules/rules.md index 1777dd7..edab96c 100644 --- a/docs/rules/rules.md +++ b/docs/rules/rules.md @@ -44,10 +44,10 @@ Rules may be specified as an array of objects, each of which have the following -| 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[] |