chore: correct partition by comment description

azat-io · Sep 22, 2024 · a9aee0c · a9aee0c
1 parent f6b7803
commit a9aee0c
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 7 deletions.
diff --git a/docs/content/rules/sort-exports.mdx b/docs/content/rules/sort-exports.mdx
@@ -110,7 +110,7 @@ Controls whether sorting should be case-sensitive or not.
 
 <sub>default: `false`</sub>
 
-Allows you to use comments to separate the members of intersection types into logical groups. This can help in organizing and maintaining large enums by creating partitions within the enum based on comments.
+Allows you to use comments to separate the exports into logical groups. This can help in organizing and maintaining large enums by creating partitions within the enum based on comments.
 
 - `true` — All comments will be treated as delimiters, creating partitions.
 -	`false` — Comments will not be used as delimiters.

diff --git a/docs/content/rules/sort-objects.mdx b/docs/content/rules/sort-objects.mdx
@@ -188,8 +188,9 @@ Controls whether sorting should be case-sensitive or not.
 Allows you to use comments to separate the keys of objects into logical groups. This can help in organizing and maintaining large enums by creating partitions within the enum based on comments.
 
 - `true` — All comments will be treated as delimiters, creating partitions.
--	`false` — Comments will not be used as delimiters.
-- string — A glob pattern to specify which comments should act as delimiters.
+- `false` — Comments will not be used as delimiters.
+- `string` — A glob pattern to specify which comments should act as delimiters.
+- `string[]` — An array of glob patterns to specify which comments should act as delimiters.
 
 ### partitionByNewLine
 

diff --git a/rules/sort-classes.ts b/rules/sort-classes.ts
@@ -72,7 +72,7 @@ export default createEslintRule<SortClassesOptions, MESSAGE_ID>({
           },
           partitionByComment: {
             description:
-              'Allows to use comments to separate the nodes into logical groups.',
+              'Allows to use comments to separate the class members into logical groups.',
             anyOf: [
               {
                 type: 'array',

diff --git a/rules/sort-enums.ts b/rules/sort-enums.ts
@@ -71,7 +71,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
           },
           partitionByComment: {
             description:
-              'Allows you to use comments to separate the class members into logical groups.',
+              'Allows you to use comments to separate the members of enums into logical groups.',
             anyOf: [
               {
                 type: 'array',

diff --git a/rules/sort-exports.ts b/rules/sort-exports.ts
@@ -61,7 +61,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
           },
           partitionByComment: {
             description:
-              'Allows you to use comments to separate the class members into logical groups.',
+              'Allows you to use comments to separate the exports into logical groups.',
             anyOf: [
               {
                 type: 'array',

diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts
@@ -86,7 +86,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
           },
           partitionByComment: {
             description:
-              'Allows you to use comments to separate the class members into logical groups.',
+              'Allows you to use comments to separate the keys of objects into logical groups.',
             anyOf: [
               {
                 type: 'array',