Skip to content

Docs: bring the docs in line with 0.3.0 and validator 0.4.0 - #5

Merged
dvejsada merged 3 commits into
mainfrom
claude/adoring-mccarthy-bzswrw
Oct 3, 2026
Merged

dvejsada merged 3 commits into
mainfrom
claude/adoring-mccarthy-bzswrw

Conversation

@dvejsada

@dvejsada dvejsada commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

This fixes the docs, docstrings and comments that were stale after 0.3.0 (#3, #4). It is documentation only: no code behaviour changes, and the tests are unchanged.

What was wrong

Two audits read every doc file and every validator-related docstring and checked them against the code and validator 0.4.0, and each fix was checked again before it went in.

  • architecture.md:
    • "Frontmatter that is not a YAML mapping" raises DocumentError. With 0.4.0, only invalid YAML does; a list in the frontmatter gives a frontmatter-absent warning.
    • The resolver's Survey step was said to collect definitions and the template decision. Those now come from result.index.
    • The public-API sentence now names the assembly calls and load_answers.
    • The answers file is now listed among the files read.
  • concepts.md: it said list enumeration, style templates and signature blocks were "planned". All three are implemented. Plain text is now listed as an output, and the answers file among the files read.
  • roadmap.md:
    • U1b said "Fixed in validator main" and "adopted with 0.3.0". They were fixed in validator 0.3.0 and adopted in renderer v0.2. A typo is also fixed.
    • U3 placed the answers reader in the tooling modules. It is on top-level legaldown.
    • The v0.3 entry now mentions the one change to rendered output.
  • README: the exit codes now include 70 (internal error), and 1 and 2 cover everything they actually cover.
  • PUBLISHING.md:
    • It said to register a pending publisher because "the project does not exist on PyPI yet". It does now.
    • "Cutting a release" was missing a step: update the HTML goldens (pytest --update-golden tests/test_golden.py), the version named in CONFORMANCE.md, and the roadmap milestone.
  • ADRs (dated notes, as the repo does):
    • 0003: the resolved/unresolved check happens at runtime, and anchors are made in Resolver._anchor.
    • 0004: the open questions' v0.3 and v0.4 now read v0.4 and v0.5.
    • 0005: currency codes are checked against the validator's KNOWN_CURRENCIES, and the formatting code is resolve/values.py, not a locale/ module.
    • 0007: a list item holds its own blocks, and the builder no longer works from item depths.
    • The decision index now describes the dated-note convention, and its Status column matches each record.
  • Docstrings and comments:
    • InternalError no longer mentions "its parser". It names the cases that actually raise it.
    • The cli.py comment and the RenderOptions.answers doc now say answers are not coerced, unlike legaldown assemble. A money amount must be a string such as "5000.00", not a number; this was checked by rendering.
    • build.py now cites ADR 0007, and its nesting-cap comment is more precise.
    • The html.py docstring now mentions the fragment output.

Left as is

  • The validator issue #93 links in the roadmap U2/U3 rows and in CONFORMANCE.md. The issue's state could not be read from this session.
  • The README uses relative links, which break on the PyPI project page. Changing that is a separate decision.
  • Whether CONFORMANCE.md should claim the §17.6 Assembly capability separately from Rendering is also a separate decision.

Checked

ruff is clean, pytest gives 192 passed and 1 skipped, and the relative links in the changed files resolve.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Q3fBapGwQ2J2vLzpDyjB5t


Generated by Claude Code

claude added 3 commits October 3, 2026 10:08
Bump the version to 0.3.0 for the release built on legaldown-validator
0.4.0's public API (#3), and name it in CONFORMANCE.md and the roadmap.
The planned DOCX and PDF milestones move to v0.4 and v0.5 (ADR 0004
gets a dated note). The two HTML goldens carry the generator version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Q3fBapGwQ2J2vLzpDyjB5t
Fix stale statements in the architecture, concepts, roadmap, README
exit codes and PUBLISHING (the project is on PyPI; the release steps
include the goldens, CONFORMANCE.md and the roadmap), add dated notes
to ADRs 0003, 0004, 0005 and 0007, match the decision index to the
records, and correct docstrings and comments that predate the
validator model (InternalError, the answers reader, the HTML fragment).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Q3fBapGwQ2J2vLzpDyjB5t
@dvejsada
dvejsada merged commit 435553c into main Oct 3, 2026
6 checks passed
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.

2 participants