Skip to content

Commit dad187e

Browse files
docs: Remove test parity script and update coverage instructions
- Replaced by test coverage and the class-coverage nox session. - Removed `scripts/check_test_parity.sh` and all references to it across documentation (`README.md`, `AGENTS.md`, and `TESTING_GUIDELINES.md`). - Updated `TESTING_GUIDELINES.md` to include instructions for running `uvx nox -s class-coverage` to enforce minimum function-level coverage on key client classes (`PdfRestClient` and `AsyncPdfRestClient`). Assisted-by: Codex
1 parent cc8de21 commit dad187e

4 files changed

Lines changed: 3 additions & 176 deletions

File tree

AGENTS.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@
1919
- `uv run pre-commit run --all-files` — enforce formatting and lint rules before
2020
pushing.
2121
- `uv run pytest` — execute the suite with the active interpreter.
22-
- `scripts/check_test_parity.sh` — run changed tests and report sync/async
23-
parity gaps (accepts optional base/head refs, defaults to
24-
`upstream/main..HEAD`).
2522
- `uv build` — produce wheels and sdists identical to the release workflow.
2623
- `uvx nox -s tests` — create matrix virtualenvs via nox and execute the pytest
2724
session.

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,3 @@ uvx nox -s class-coverage
4545

4646
To reuse an existing `coverage/py<version>/coverage.json` without rerunning
4747
tests, add `-- --no-tests` (and optional `--coverage-json path`).
48-
49-
Check sync/async parity for changed tests (defaults to `upstream/main..HEAD`):
50-
51-
```bash
52-
scripts/check_test_parity.sh
53-
```

TESTING_GUIDELINES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ iteration required.
1919
asserting method/path/headers/body). Optional payload branches (for example,
2020
`pages`, `output`, `rgb_color`, and output-prefix fields) require explicit
2121
tests so serialization differences are caught early.
22-
- **Check parity regularly.** Run `scripts/check_test_parity.sh` (defaults to
23-
`upstream/main..HEAD`) to spot missing sync/async counterparts, keeping
24-
parameterized test IDs aligned between transports.
22+
- **Check client coverage regularly.** Run `uvx nox -s class-coverage` to
23+
enforce minimum function-level coverage for `PdfRestClient` and
24+
`AsyncPdfRestClient`.
2525
- **Exercise both sides of the contract.** Hermetic tests (via
2626
`httpx.MockTransport`) validate serialization and local validation. Live
2727
suites prove the server behaves the same way, including invalid literal

scripts/check_test_parity.sh

Lines changed: 0 additions & 164 deletions
This file was deleted.

0 commit comments

Comments
 (0)