Skip to content

Commit 3069b0e

Browse files
committed
docs(coverage.md): update command references for coverage operations
Revise documentation to reflect the updated command structure for coverage operations, changing references from `tux dev` to `tux test`. This ensures clarity and accuracy in the documentation, aligning it with the current CLI commands for running tests and generating coverage reports.
1 parent 4a7a5b1 commit 3069b0e

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/content/dev/coverage.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ The easiest way to run coverage is through the built-in Tux CLI:
1010

1111
```bash
1212
# Run tests with coverage
13-
poetry run tux dev test
13+
poetry run tux test run
1414

1515
# Run tests without coverage (faster)
16-
poetry run tux dev test-quick
16+
poetry run tux test quick
1717

1818
# Generate coverage reports
19-
poetry run tux dev coverage --format=html
20-
poetry run tux dev coverage --format=xml
21-
poetry run tux dev coverage --fail-under=90
19+
poetry run tux test coverage --format=html
20+
poetry run tux test coverage --format=xml
21+
poetry run tux test coverage --fail-under=90
2222

2323
# Clean coverage files
24-
poetry run tux dev coverage-clean
24+
poetry run tux test coverage-clean
2525
```
2626

2727
### Direct pytest Commands
@@ -45,16 +45,16 @@ Coverage functionality is integrated into the main CLI:
4545

4646
```bash
4747
# Run tests with coverage report
48-
poetry run tux dev coverage
48+
poetry run tux test coverage
4949

5050
# Generate HTML report
51-
poetry run tux dev coverage --format=html
51+
poetry run tux test coverage --format=html
5252

5353
# Clean coverage files
54-
poetry run tux dev coverage-clean
54+
poetry run tux test coverage-clean
5555

5656
# See all available options
57-
poetry run tux dev coverage --help
57+
poetry run tux test coverage --help
5858
```
5959

6060
## Configuration
@@ -119,13 +119,13 @@ TOTAL 179 151 62 0 15.64%
119119
Generates a detailed interactive HTML report in `htmlcov/`:
120120

121121
```bash
122-
poetry run tux dev coverage --format=html
122+
poetry run tux test coverage --format=html
123123
# Generates htmlcov/index.html
124124

125125
# Open the report in browser
126-
poetry run tux dev coverage --format=html --open
126+
poetry run tux test coverage --format=html --open
127127
# or open it separately
128-
poetry run tux dev coverage-open
128+
poetry run tux test coverage-open
129129
```
130130

131131
The HTML report provides:
@@ -140,7 +140,7 @@ The HTML report provides:
140140
For CI/CD integration:
141141

142142
```bash
143-
poetry run tux dev coverage --format=xml
143+
poetry run tux test coverage --format=xml
144144
# Generates coverage.xml
145145
```
146146

@@ -149,7 +149,7 @@ poetry run tux dev coverage --format=xml
149149
Machine-readable format:
150150

151151
```bash
152-
poetry run tux dev coverage --format=json
152+
poetry run tux test coverage --format=json
153153
# Generates coverage.json
154154
```
155155

@@ -177,7 +177,7 @@ def test_new_feature():
177177
Run coverage reports to identify untested code:
178178

179179
```bash
180-
poetry run tux dev coverage | grep "0.00%"
180+
poetry run tux test coverage | grep "0.00%"
181181
```
182182

183183
### 3. Exclude Appropriate Code

0 commit comments

Comments
 (0)