Skip to content

Commit 0d94ede

Browse files
committed
docs: improve wordings in guides
1 parent de92071 commit 0d94ede

5 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/content/configs/recommended-alphabetical.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ Configuration for the `eslint-plugin-perfectionist` plugin, which provides all p
2020

2121
Uses [localeCompare](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare) to sort elements.
2222

23-
It makes it just a tiny bit faster to find a declaration in a large list. Remember, you read code far more than you write it.
23+
It makes it just a bit faster to find a declaration in a large list. Remember, you read code far more than you write it.
2424

2525
## When to Use
2626

27-
Use the recommended-alphabetical configuration when you want to enforce a consistent alphabetical order across various data structures in your codebase.
27+
Use the `recommended-alphabetical` configuration when you want to enforce a consistent alphabetical order across various data structures in your codebase.
2828

29-
This configuration is particularly useful in large projects where readability and maintainability are crucial.
29+
This configuration is particularly useful for large projects where readability and maintainability are crucial.
3030

31-
It helps in quickly locating declarations and ensures that similar elements are grouped together, reducing cognitive load for developers navigating the code.
31+
It helps quickly locate declarations and ensures that similar elements are grouped together, reducing cognitive load for developers navigating the code.
3232

3333
## Usage
3434

docs/content/configs/recommended-custom.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ import dedent from 'dedent'
1818

1919
Configuration for the `eslint-plugin-perfectionist` plugin, which provides all plugin rules with your predefined custom ordered alphabet.
2020

21-
This configuration allows you to define your own custom order for sorting elements in your codebase as you truly desire.
21+
This configuration allows you to define your own custom order for sorting elements in your codebase as you desire.
2222

2323
## When to Use
2424

25-
Each rule in `eslint-plugin-perfectionist` offers a lot of options that should suit most use cases.
25+
Each rule in `eslint-plugin-perfectionist` offers many options that should suit most use cases.
2626

2727
If this is not enough, you may define your own alphabet and use the `recommended-custom` configuration to enforce a consistent custom order across various data structures in your codebase.
2828

29-
Use this configuration to precisely tune how elements should be sorted while keeping readability and maintainability to their highest levels.
29+
Use this configuration to precisely tune how elements should be sorted while keeping readability and maintainability at their highest levels.
3030

3131
## Usage
3232

docs/content/configs/recommended-line-length.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ import dedent from 'dedent'
2727

2828
Configuration for the `eslint-plugin-perfectionist` plugin, which provides all plugin rules with preset options: sorting by string length in descending order.
2929

30-
This configuration will make your code prettier and more pleasing to the eye.
30+
This configuration will make your code prettier and more visually pleasing.
3131

3232
## When to Use
3333

3434
Use the `recommended-line-length` configuration when you want your code to look neat and visually pleasing.
3535

36-
This configuration is especially useful in projects where the aesthetic appearance of the code is important and where developers appreciate clean alignment and visual harmony. It helps create code that is easier to read and perceive by minimizing visual clutter and enhancing the overall structure of the code.
36+
This configuration is especially useful for projects where the aesthetic appearance of the code is important and where developers appreciate clean alignment and visual harmony. It helps create code that is easier to read and perceive by minimizing visual clutter and enhancing the overall structure of the code.
3737

3838
## Usage
3939

docs/content/configs/recommended-natural.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ This configuration will allow you to navigate through your code faster because a
2929

3030
## When to Use
3131

32-
Use the recommended-natural configuration if you want elements in your code to be sorted in a way that feels more intuitive to humans.
32+
Use the `recommended-natural` configuration if you want elements in your code to be sorted in a way that feels more intuitive to humans.
3333

34-
This configuration is particularly useful in projects where an intuitive understanding of the order of elements is important, such as version files, task lists, or any other data sets that contain numerical values. Natural sorting makes your code more readable and easier to comprehend, especially in situations where numerical values play a key role.
34+
This configuration is particularly useful for projects where an intuitive understanding of the order of elements is important, such as version files, task lists, or any other data sets that contain numerical values. Natural sorting makes your code more readable and easier to comprehend, especially in situations where numerical values play a key role.
3535

3636
## Usage
3737

docs/content/guide/getting-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Your support helps the continued development and improvement of this project.
2525

2626
## Installation
2727

28-
Okay, let's get started. You'll first need to install [ESLint](https://eslint.org/) v8.45.0 or greater:
28+
Let's get started. You'll need to install [ESLint](https://eslint.org/) v8.45.0 or greater:
2929

3030
<CodeTabs
3131
code={[
@@ -136,9 +136,9 @@ lang="tsx"
136136

137137
Many rules have common settings. You can set them in the `settings` field.
138138

139-
The highest priority is given to the settings of a particular rule. Next comes the settings field and the lowest priority has default values.
139+
The highest priority is given to the settings of a particular rule. Next comes the settings field, and then the default values.
140140

141-
In settings you can set the following options:
141+
In settings, you can set the following options:
142142

143143
- `type` — The type of sorting. Possible values are `'alphabetical'`, `'natural'`, `'line-length'` and `custom`.
144144
- `order` — The order of sorting. Possible values are `'asc'` and `'desc'`.

0 commit comments

Comments
 (0)