Skip to content

docs(AGENTS): add smoke-tests subtree, trim SshCache 0.15.0 duplication - #612

Merged
pmrv merged 1 commit into
mainfrom
claude/charming-mayer-Mpaha
Jun 2, 2026
Merged

docs(AGENTS): add smoke-tests subtree, trim SshCache 0.15.0 duplication#612
pmrv merged 1 commit into
mainfrom
claude/charming-mayer-Mpaha

Conversation

@pmrv

@pmrv pmrv commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Audit pass of AGENTS.md against current main (3a34ea7). Architecture / Key-files / MRO / Storage-composition sections were all verified accurate against the source — the only material drift is in the Test-layout section after PR #609, plus a few sites that triple-list the SshCache 0.15.0 / python -m fleche story.

What changed

Test layout

  • Add a smoke/ bullet covering tests/smoke/test_optional_deps.py (PR Add fast smoke-test set touching each optional dependency #609): one tiny @fleche() round-trip per optional dep (cloudpickle / dill / sqlalchemy / bagofholding / attrs), asserting the second call is served from the backend so the dep is genuinely functional (not just importable). Selectable with pytest -m smoke; uses pytest.importorskip so absent deps skip rather than fail.
  • Reword the pytest-config sentence — pyproject.toml does now have [tool.pytest.ini_options] (registers the smoke marker, also from Add fast smoke-test set touching each optional dependency #609). The doc still claimed there was no such section.
  • Disambiguate unit/storage/test_optional_deps.py (existing full-coverage per-backend file) from the new smoke/test_optional_deps.py — a reader scanning the file list shouldn't conflate them.

Trim SshCache / CLI repetition

"SshCache shipped in 0.15.0 via python -m fleche remote --serve (PR #597 CLI dispatcher)" was being told three times:

  • remote.py row: dropped the landed #551 / released 0.15.0 aside and the PR #597 moved the CLI behind a dispatcher parenthetical. The form is what callers need; the archaeology is one line of git log away.
  • "Distributed / remote caching" design theme: removed the repeated SshCache feature description so the bullet covers only what's still open (#552 cold-tier values).
  • "Decisions already landed": collapsed the separate SshCache and CLI consolidated bullets into one — the CLI dispatcher is part of the SshCache delivery story, no value in listing twice.

Also alphabetised the __all__ enumeration in the remote.py row to match the source (["RemoteConnectionError", "SshCache", "serve"]).

Verified (no changes needed)

Test plan

  • Docs-only change.
  • git diff --stat AGENTS.md1 file changed, 7 insertions(+), 7 deletions(-).

Generated by Claude Code

Audit pass against current main. Architecture and Test-layout sections
both had small accuracy drift since #609:

- `tests/smoke/test_optional_deps.py` (PR #609) is not mentioned; add a
  bullet under Test layout describing the `-m smoke` marker, the
  per-extra round-trip pattern, and its role as a pre-release sanity
  check on the packaged distribution.
- `pyproject.toml` now carries `[tool.pytest.ini_options]` (registering
  the `smoke` marker — also from #609); the doc still claimed there was
  no such section. Reworded the pytest-config sentence.
- Disambiguated `unit/storage/test_optional_deps.py` (the existing
  full-coverage per-backend file) from the new `smoke/test_optional_deps.py`
  so a reader doesn't conflate them.

Trimmed three sites that all said "SshCache shipped in 0.15.0 via the
`python -m fleche remote --serve` dispatcher (PR #597)":

- `remote.py` row: dropped the `landed #551 / released 0.15.0` aside and
  the `PR #597 moved the CLI` parenthetical (the form is what matters
  for callers; the history is one line of git away).
- "Distributed / remote caching" design-theme bullet: removed the
  repeated SshCache description so the bullet covers only what's still
  open (#552 cold-tier values).
- "Decisions already landed" SshCache + CLI bullets: collapsed two
  bullets into one — the CLI dispatcher is part of the SshCache delivery
  story, no need to list it separately.

Also alphabetised the `__all__` enumeration in the `remote.py` row to
match the source.
@pmrv
pmrv merged commit 18f3e61 into main Jun 2, 2026
5 checks passed
@pmrv
pmrv deleted the claude/charming-mayer-Mpaha branch June 2, 2026 04:15
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