docs: Error semantics docs updates

[michaelthomasletts]

All submissions

• Does your pull request title follow Conventional Commits (type(scope)!: summary)?
  • Allowed type values in this repository: feat, fix, perf, refactor, docs, style, test, build, ci, chore, revert.
  • Example pull request title: fix(cache): add a new parameter to ClientCache.
  • For breaking changes in PR titles, use ! before : (example: feat!: remove deprecated cache API).
  • You can find additional details here.
  • Release Please uses these commit types to determine release bumps (feat -> minor, fix/perf -> patch, ! -> major).
• Did you verify that your changes pass pre-commit checks before opening this pull request?
  • The pre-commit checks are identical to required status checks for pull requests in this repository. Know that suppressing pre-commit checks via the --no-verify | -nv arguments will not help you avoid the PR status checks!
  • To ensure that pre-commit checks work on your branch before running git commit, run pre-commit install and pre-commit install-hooks beforehand.
  • If needed, run the full suite locally with pre-commit run --all-files.
• Have you checked that your changes don't relate to other open pull requests?

Submission details

The following PR creates basic semantic updates to the error docs in the README for easier comprehension and legibility.

[Copilot]

Pull request overview

Updates documentation error semantics wording/formatting to improve readability in both the README and Sphinx docs.

Changes:

• Replaces double-hyphen punctuation with an em dash in “Design” wording.
• Adds clarifying inline comments to the README’s “Error semantics” code example.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
README.md	Adjusts design prose punctuation and clarifies error semantics example comments.
docs/index.rst	Mirrors the design prose punctuation update in Sphinx index docs.

Comments suppressed due to low confidence (1)

README.md:166

• This wrapped comment leaves a trailing space at end-of-line (line 165). Reflowing it to a single line avoids EOL whitespace and keeps the example readable.

# raises ClientCacheNotFoundError b/c the specific client was not 
# cached above

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

README.md:162

• The comment line has trailing whitespace (likely failing whitespace-trimming hooks) and references "pseudo-code" even though this section shows concrete examples; also consider matching the actual call shown below (boto3.client).

# raises ClientCacheExistsError b/c client(**kwargs) already exists
# (from the pseudo-code above)

README.md:166

• This wrapped comment includes trailing whitespace and can be expressed as a single line for readability (and to avoid whitespace issues in Markdown code blocks).

# raises ClientCacheNotFoundError b/c the specific client was not
# cached above

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

README.md:166

• The line break in this comment splits the phrase “was not cached” across lines and changes the original meaning slightly (“cached above”). Consider rephrasing so the wrapped comment reads naturally and doesn’t depend on “above” wording.

# raises ClientCacheNotFoundError b/c the specific client was not
# cached above