fix: correct rule description

sveltejs · Nov 27, 2024 · a77b03e · a77b03e
1 parent bc20978
commit a77b03e
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -380,7 +380,7 @@ These rules relate to possible syntax or logic errors in Svelte code:
 | Rule ID | Description |    |
 |:--------|:------------|:---|
 | [svelte/infinite-reactive-loop](https://sveltejs.github.io/eslint-plugin-svelte/rules/infinite-reactive-loop/) | Svelte runtime prevents calling the same reactive statement twice in a microtask. But between different microtask, it doesn't prevent. |  |
-| [svelte/no-deprecated-raw-special-elements](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-deprecated-raw-special-elements/) | Disallows valid Svelte 4 tags, that no are no longer valid in Svelte 5 | :wrench: |
+| [svelte/no-deprecated-raw-special-elements](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-deprecated-raw-special-elements/) | Recommends not using raw special elements in Svelte versions previous to 5. | :wrench: |
 | [svelte/no-dom-manipulating](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-dom-manipulating/) | disallow DOM manipulating |  |
 | [svelte/no-dupe-else-if-blocks](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-dupe-else-if-blocks/) | disallow duplicate conditions in `{#if}` / `{:else if}` chains | :star: |
 | [svelte/no-dupe-on-directives](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-dupe-on-directives/) | disallow duplicate `on:` directives |  |

diff --git a/docs/rules.md b/docs/rules.md
@@ -17,7 +17,7 @@ These rules relate to possible syntax or logic errors in Svelte code:
 | Rule ID                                                                                                        | Description                                                                                                                            |                |
 | :------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------- | :------------- |
 | [svelte/infinite-reactive-loop](./rules/infinite-reactive-loop.md)                                             | Svelte runtime prevents calling the same reactive statement twice in a microtask. But between different microtask, it doesn't prevent. |                |
-| [svelte/no-deprecated-raw-special-elements](./rules/no-deprecated-raw-special-elements.md)                     | Disallows valid Svelte 4 tags, that no are no longer valid in Svelte 5                                                                 | :wrench:       |
+| [svelte/no-deprecated-raw-special-elements](./rules/no-deprecated-raw-special-elements.md)                     | Recommends not using raw special elements in Svelte versions previous to 5.                                                            | :wrench:       |
 | [svelte/no-dom-manipulating](./rules/no-dom-manipulating.md)                                                   | disallow DOM manipulating                                                                                                              |                |
 | [svelte/no-dupe-else-if-blocks](./rules/no-dupe-else-if-blocks.md)                                             | disallow duplicate conditions in `{#if}` / `{:else if}` chains                                                                         | :star:         |
 | [svelte/no-dupe-on-directives](./rules/no-dupe-on-directives.md)                                               | disallow duplicate `on:` directives                                                                                                    |                |

diff --git a/docs/rules/no-deprecated-raw-special-elements.md b/docs/rules/no-deprecated-raw-special-elements.md
@@ -2,7 +2,7 @@
 pageClass: 'rule-details'
 sidebarDepth: 0
 title: 'svelte/no-deprecated-raw-special-elements'
-description: 'Disallows valid Svelte 4 tags, that no are no longer valid in Svelte 5'
+description: 'Recommends not using raw special elements in Svelte versions previous to 5.'
 ---
 
 # svelte/no-deprecated-raw-special-elements

diff --git a/packages/eslint-plugin-svelte/src/rule-types.ts b/packages/eslint-plugin-svelte/src/rule-types.ts
@@ -105,7 +105,7 @@ export interface RuleOptions {
    */
   'svelte/no-at-html-tags'?: Linter.RuleEntry<[]>
   /**
-   * Disallows valid Svelte 4 tags, that no are no longer valid in Svelte 5
+   * Recommends not using raw special elements in Svelte versions previous to 5.
    * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/no-deprecated-raw-special-elements/
    */
   'svelte/no-deprecated-raw-special-elements'?: Linter.RuleEntry<[]>

diff --git a/packages/eslint-plugin-svelte/src/rules/no-deprecated-raw-special-elements.ts b/packages/eslint-plugin-svelte/src/rules/no-deprecated-raw-special-elements.ts
@@ -7,7 +7,7 @@ const VALID_PREFIX = 'svelte:';
 export default createRule('no-deprecated-raw-special-elements', {
 	meta: {
 		docs: {
-			description: 'Disallows valid Svelte 4 tags, that no are no longer valid in Svelte 5',
+			description: 'Recommends not using raw special elements in Svelte versions previous to 5.',
 			category: 'Possible Errors',
 			// TODO: Switch to recommended in the major version
 			recommended: false