Repository navigation
Docs: bring the docs in line with 0.3.0 and validator 0.4.0 - #5
Merged
Merged
Conversation
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
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
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.
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.
DocumentError. With 0.4.0, only invalid YAML does; a list in the frontmatter gives afrontmatter-absentwarning.result.index.load_answers.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.legaldown.pytest --update-golden tests/test_golden.py), the version named inCONFORMANCE.md, and the roadmap milestone.Resolver._anchor.KNOWN_CURRENCIES, and the formatting code isresolve/values.py, not alocale/module.InternalErrorno longer mentions "its parser". It names the cases that actually raise it.cli.pycomment and theRenderOptions.answersdoc now say answers are not coerced, unlikelegaldown assemble. A money amount must be a string such as"5000.00", not a number; this was checked by rendering.build.pynow cites ADR 0007, and its nesting-cap comment is more precise.html.pydocstring now mentions the fragment output.Left as is
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