chore: tweak lint doc

biomejs · Mar 23, 2024 · caca5f4 · caca5f4
1 parent 990823f
commit caca5f4
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 18 deletions.
diff --git a/crates/biome_css_analyze/src/lint/nursery/no_color_invalid_hex.rs b/crates/biome_css_analyze/src/lint/nursery/no_color_invalid_hex.rs
@@ -4,14 +4,9 @@ use biome_css_syntax::CssDeclarationOrRuleBlock;
 use biome_rowan::AstNode;
 
 declare_rule! {
-    /// Succinct description of the rule.
+    /// **[WIP] This rule hasn't been implemented yet.**
     ///
-    /// Put context and details about the rule.
-    /// As a starting point, you can take the description of the corresponding _ESLint_ rule (if any).
-    ///
-    /// Try to stay consistent with the descriptions of implemented rules.
-    ///
-    /// Add a link to the corresponding stylelint rule (if any):
+    /// This is sample rule
     ///
     /// ## Examples
     ///

diff --git a/crates/biome_service/src/configuration/linter/rules.rs b/crates/biome_service/src/configuration/linter/rules.rs
diff --git a/packages/@biomejs/backend-jsonrpc/src/workspace.ts b/packages/@biomejs/backend-jsonrpc/src/workspace.ts
diff --git a/packages/@biomejs/biome/configuration_schema.json b/packages/@biomejs/biome/configuration_schema.json
diff --git a/website/src/content/docs/linter/rules/index.mdx b/website/src/content/docs/linter/rules/index.mdx
@@ -252,7 +252,7 @@ Rules that belong to this group <strong>are not subject to semantic version</str
 | Rule name | Description | Properties | Language |
 | --- | --- | --- | --- |
 | [noBarrelFile](/linter/rules/no-barrel-file) | Disallow the use of barrel file. |  | <img alt="JavaScript logo" src="/src/assets/svg/js-icon.svg" /> |
-| [noColorInvalidHex](/linter/rules/no-color-invalid-hex) | Succinct description of the rule. |  | <img alt="JavaScript logo" src="/src/assets/svg/css-icon.svg" /> |
+| [noColorInvalidHex](/linter/rules/no-color-invalid-hex) | <strong>[WIP] This rule hasn't been implemented yet.</strong> |  | <img alt="JavaScript logo" src="/src/assets/svg/css-icon.svg" /> |
 | [noConsole](/linter/rules/no-console) | Disallow the use of <code>console</code>. | <span aria-label="The rule has an unsafe fix" role="img" title="The rule has an unsafe fix">⚠️ </span> | <img alt="JavaScript logo" src="/src/assets/svg/js-icon.svg" /> |
 | [noDoneCallback](/linter/rules/no-done-callback) | Disallow using a callback in asynchronous tests and hooks. |  | <img alt="JavaScript logo" src="/src/assets/svg/js-icon.svg" /> |
 | [noDuplicateElseIf](/linter/rules/no-duplicate-else-if) | Disallow duplicate conditions in if-else-if chains |  | <img alt="JavaScript logo" src="/src/assets/svg/js-icon.svg" /> |

diff --git a/website/src/content/docs/linter/rules/no-color-invalid-hex.md b/website/src/content/docs/linter/rules/no-color-invalid-hex.md
@@ -12,14 +12,9 @@ This rule hasn't been released yet.
 This rule is part of the [nursery](/linter/rules/#nursery) group.
 :::
 
-Succinct description of the rule.
+**[WIP] This rule hasn't been implemented yet.**
 
-Put context and details about the rule.
-As a starting point, you can take the description of the corresponding _ESLint_ rule (if any).
-
-Try to stay consistent with the descriptions of implemented rules.
-
-Add a link to the corresponding stylelint rule (if any):
+This is sample rule
 
 ## Examples