Skip to content

Commit d68ed0f

Browse files
committed
fix: Correct numerous linting errors in the README.md file.
1 parent 231533a commit d68ed0f

File tree

1 file changed

+37
-38
lines changed

1 file changed

+37
-38
lines changed

README.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -97,67 +97,66 @@ several modes, configured through the `--reorder-by-technique` option.
9797

9898
You can reorder your tests based on a variety of criteria:
9999

100-
- **`cost`**: Reorders tests based on their execution time from the previous
101-
run. This is perfect for getting quick feedback by running faster tests
102-
first.
103-
- **`name`**: Reorders tests alphabetically by their name.
104-
- **`failure`**: Reorders tests based on their failure history, running tests
105-
that failed in the previous run first. This is a powerful technique for
106-
regression testing.
100+
- **`cost`**: Reorders tests based on their execution time from the previous
101+
run. This is perfect for getting quick feedback by running faster tests first.
102+
- **`name`**: Reorders tests alphabetically by their name.
103+
- **`failure`**: Reorders tests based on their failure history, running tests
104+
that failed in the previous run first. This is a powerful technique for
105+
regression testing.
107106

108107
### Shuffling
109108

110-
- **`shuffle`**: Randomizes the order of your tests. This is an excellent way
111-
to uncover hidden dependencies between tests and identify "flaky" tests
112-
that pass or fail based on the order in which they are run.
109+
- **`shuffle`**: Randomizes the order of your tests. This is an excellent way to
110+
uncover hidden dependencies between tests and identify "flaky" tests that pass
111+
or fail based on the order in which they are run.
113112

114113
## ⚙️ Command-Line Arguments
115114

116115
Here's a breakdown of the command-line arguments you can use to control
117116
`pytest-brightest`:
118117

119-
- `--brightest`
120-
- **Description**: Enable the `pytest-brightest` plugin.
121-
- **Default**: `False`
122-
- `--reorder-by-technique`
123-
- **Description**: The technique to use for reordering or shuffling tests.
124-
- **Options**: `shuffle`, `name`, `cost`, `failure`
125-
- **Default**: `None`
126-
- `--reorder-by-focus`
127-
- **Description**: The scope of the reordering or shuffling.
128-
- **Options**: `modules-within-suite`, `tests-within-module`,
129-
`tests-across-modules`
130-
- **Default**: `tests-across-modules`
131-
- `--reorder-in-direction`
132-
- **Description**: The direction of the reordering.
133-
- **Options**: `ascending`, `descending`
134-
- **Default**: `ascending`
135-
- `--seed`
136-
- **Description**: A seed for the random number generator used for
137-
shuffling, ensuring reproducible results.
138-
- **Default**: (random)
118+
- `--brightest`
119+
- **Description**: Enable the `pytest-brightest` plugin.
120+
- **Default**: `False`
121+
- `--reorder-by-technique`
122+
- **Description**: The technique to use for reordering or shuffling tests.
123+
- **Options**: `shuffle`, `name`, `cost`, `failure`
124+
- **Default**: `None`
125+
- `--reorder-by-focus`
126+
- **Description**: The scope of the reordering or shuffling.
127+
- **Options**: `modules-within-suite`, `tests-within-module`,
128+
`tests-across-modules`
129+
- **Default**: `tests-across-modules`
130+
- `--reorder-in-direction`
131+
- **Description**: The direction of the reordering.
132+
- **Options**: `ascending`, `descending`
133+
- **Default**: `ascending`
134+
- `--seed`
135+
- **Description**: A seed for the random number generator used for
136+
shuffling, ensuring reproducible results.
137+
- **Default**: (random)
139138

140139
### Examples
141140

142-
#### Run faster tests first:
141+
#### Run faster tests first
143142

144143
```bash
145144
pytest --brightest --reorder-by-technique cost --reorder-in-direction ascending
146145
```
147146

148-
#### Run previously failing tests first:
147+
#### Run previously failing tests first
149148

150149
```bash
151150
pytest --brightest --reorder-by-technique failure --reorder-in-direction descending
152151
```
153152

154-
#### Shuffle all tests with a specific seed:
153+
#### Shuffle all tests with a specific seed
155154

156155
```bash
157156
pytest --brightest --reorder-by-technique shuffle --seed 12345
158157
```
159158

160-
#### Shuffle tests within each module, but keep the module order:
159+
#### Shuffle tests within each module, but keep the module order
161160

162161
```bash
163162
pytest --brightest --reorder-by-technique shuffle --reorder-by-focus tests-within-module
@@ -168,7 +167,7 @@ pytest --brightest --reorder-by-technique shuffle --reorder-by-focus tests-withi
168167
Contributions are welcome! This project is open-source and thrives on community
169168
involvement. Let's make testing brighter, together.
170169

171-
- **Issues**: If you find a bug or have a feature request, please [open an
172-
issue](https://github.com/AstuteSource/pytest-brightest/issues).
173-
- **Pull Requests**: If you'd like to contribute code, please [submit a pull
174-
request](https://github.com/AstuteSource/pytest-brightest/pulls).
170+
- **Issues**: If you find a bug or have a feature request, please [open an
171+
issue](https://github.com/AstuteSource/pytest-brightest/issues).
172+
- **Pull Requests**: If you'd like to contribute code, please [submit a pull
173+
request](https://github.com/AstuteSource/pytest-brightest/pulls).

0 commit comments

Comments
 (0)