Skip to content

docs: remove em-dashes from docs, docstrings and tests - #99

Merged
vvillait88 merged 1 commit into
mainfrom
docs-no-em-dashes
Oct 3, 2026
Merged

vvillait88 merged 1 commit into
mainfrom
docs-no-em-dashes

Conversation

@vvillait88

Copy link
Copy Markdown
Contributor

Summary

Removes every em-dash from the repo: the docs, the doc comments that ship in the published package (and show in editors), code comments and test names. A spaced em-dash became a colon in comments and test names, and a comma or colon in the docs; the two paired dashes around the test-mode outcome list became parentheses. Found in a docs audit across every repo.

No runtime string changes, so no release is cut for this; the next release carries it.

Type of change

  • Bug fix (no breaking change)
  • New feature (no breaking change)
  • Breaking change (existing callers must update)
  • Docs, tests, or internal maintenance only

Public API

None. Comments and doc text only.

Test plan

Lint, format/type checks and the full test suite run locally, all exit 0. A repo-wide count of em-dashes after the change is 0.

Checklist

  • Tests cover the new behavior, and the suite passes locally (no behavior changed; suite passes)
  • Lint, format, and type checks pass
  • Docs and README examples updated if the public surface changed
  • No secrets, credentials, or personal data in the diff or the tests

@vvillait88
vvillait88 merged commit 6629dd2 into main Oct 3, 2026
12 checks passed
@vvillait88
vvillait88 deleted the docs-no-em-dashes branch October 3, 2026 22:35
@vvillait88 vvillait88 mentioned this pull request Oct 4, 2026
5 of 8 tasks
vvillait88 added a commit that referenced this pull request Oct 4, 2026
## Summary

Releases 2.7.1, carrying everything merged since 2.7.0:

- deprecation notes on `refresh` and on the `create_session` `address`
and `operator_token` arguments, which the API ignores (#101)
- `X-Quota-Reset` documented as a UTC date rather than a timestamp
(#100)
- docstring and README cleanup (#99)
- the uv prerelease rule matching python-commerce (#98) and a dependency
sweep, uv 0.12.23 (#97)

Worked with: Varun.

Out of scope: no runtime behavior changes; the deprecated options keep
working as before.

## Type of change

- [ ] Bug fix (no breaking change)
- [ ] New feature (no breaking change)
- [ ] Breaking change (existing callers must update)
- [x] Docs, tests, or internal maintenance only

## Public API

none. The deprecations are docstring notes only; signatures and wire
formats are unchanged.

## Test plan

`ruff check`, `ruff format --check`, `ty check` and `pytest` (177
passed, 2 skipped, 99.82% coverage) pass locally on this branch.

## Checklist

- [x] Tests cover the new behavior, and the suite passes locally
- [x] Lint, format, and type checks pass
- [x] Docs and README examples updated if the public surface changed
- [x] No secrets, credentials, or personal data in the diff or the tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant