docs: epythet WP6 sweep — repair, coverage, README, docsrc cleanup - #32
Merged
Merged
Conversation
Blank lines before nested list items, RST literal blocks for the pseudo-dict examples in SpecMakerBase, a valid code-block directive for the ASCII dag in front.dag, double backticks for inline code, bullet-list continuation indent in simple_mall_dispatch_core_func, and a summary line for mk_binder.
…p stray blank line Closes the last coverage gate (D102) the sweep left open; D105/D107 (other dunders) are not gated by the docstring-style policy. See i2mint/epythet#16 WP6.
…For-AI-agents section The README described a class hierarchy (AppMakerBase, ElementTreeMakerBase, NamedContainerBase) that no longer exists — replaced with a verified, runnable example against the current API (AppMaker, SpecMakerBase, ElementTreeMaker, FrontContainerBase/FrontComponentBase). docsrc/ is regenerated by CI on every build (epythet quickstart), so it is gitignored rather than committed; added the "For AI agents" section via `epythet ai-readme-check --write` per local policy. See i2mint/epythet#16 WP6.
…dill_stores
mk_tmp_dol_dir("crude") returns the same stable path on every call, not a
fresh one per call. Caught by the adversarial review pass (i2mint/epythet#16
WP6) and verified by running it.
20 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WP6 documentation sweep for
front(i2mint/epythet#16). A prior high-effort session left partial, unreviewed work on this branch (see the epic's "Course correction" comment); this session reviewed that work line by line against the behaviour-claim policy and the knownepythet repairdefect classes (i2mint/epythet#27/#28), then continued the sweep to completion.Review of the prior partial work
All 15 files of the prior commit (
043b4bd) were docstring coverage/correctness/completeness additions, not mechanicalrepairoutput, so the #27 defect classes (box-drawing lines, Google-section-body rewrites, bare#headings, etc.) didn't apply. Verified instead by:pytest --doctest-modules): all pass.:raises:claim against an actualraisein the source.RuntimeError/KeyErrormismatch between two different functions — both are correct for their own implementation).Nothing was reverted; the prior work was sound.
What this session did
__call__methods Ruff flagged asD102(Crudifier.__call__,FrontElementBase.__call__,IsInstanceOf.__call__); removed a strayD202blank line instate.py.D105/D107(other dunders) are left undocumented per the docstring-style skill — they aren't gated.mk_mall_of_dill_stores's docstring claimedrootdirdefaults to "a fresh temporary directory" — verified by running it thatmk_tmp_dol_dir("crude")actually returns the same stable path on every call. Fixed the claim.AppMakerBase,ElementTreeMakerBase,NamedContainerBase) that no longer exists anywhere in the package — replaced with a runnable example against the current API (AppMaker,SpecMakerBase,ElementTreeMaker,FrontContainerBase/FrontComponentBase), verified by executing it. Added the "For AI agents" section viaepythet ai-readme-check --writeper local policy (add, humour on, agents first).docsrc/: was a committed, stale legacy epythet template (no hand-written pages) — deleted and added to.gitignore; CI regenerates it on every build via the existing wads reusable-workflow Pages job.docs/: a stale, tracked, pre-built HTML output directory (from an old Sphinx workflow) — deleted; already gitignored (docs/*) and superseded by the standard gh-pages job in.github/workflows/ci.yml.frontships no skills or subagents (skills_location: "none"), recorded to the local fleet-sweep inventory for thorwhalen/priv#155.Before / after
pytest -qpytest --doctest-modules(front, excl. examples/scrap — optional-dep-only scripts, pre-existing)epythet validate -i tests/ scrap/ examples/ -- frontepythet validate --level 2(Sphinx build, same ignores)epythet ai-readme-check .Remaining warnings are all
D105/D107(undocumented dunders — not gated by the docstring-style policy) plus oneDQ002info:FrontComponentBase(apass-only marker base class) has no standalone doctest — declined; its behaviour is only meaningful through concrete subclasses, all of which already carry runnable examples (InputBase,TextSectionBase,OutputBase, etc.).Claims declined
FrontComponentBase: no doctest added (see above) — a marker class with no behaviour of its own to demonstrate.simple_namer's default suffix,MultiSourceInputBase's shared child spec,TextInputBase's default view value) — all re-verified against source during this session's review; no changes needed.Theme
Left at the fleet default (
theme = "auto", no[tool.epythet]needed) —frontis a small utility library, not brand/landing-page, data/ML, or notebook-heavy.Closes nothing new; tracked under i2mint/epythet#16 (WP6).