docs: simplify the README, and drop a wrong version claim - #98
Merged
Conversation
300 lines to 201. No contract changes. The Status section said "The latest published release is v2.0.0" while the package shipped 2.7.1. `test_docs_sync.py` guards the install lines and the CITATION version, and it never saw this one. The claim is gone rather than corrected, because the changelog already carries the release timeline and a second copy is a second thing to drift. What else changed. The install section repeated one URL seven times and now shows the pattern twice. "What it does" and "What this is - and isn't" overlapped and merged. The three analytical layers lose their numbered subsection headings and keep every field name. What did not change. Every discourse label, every output filename, and every CLI subcommand stay, because `test_docs_sync.py` holds the README to all three. The label list and the output-layout block are carried through verbatim rather than retyped. 509 passed. 11 docs-sync tests pass.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
300 lines to 201. No contract changes.
A wrong claim was in there
The Status section read:
The package ships 2.7.1.
test_docs_sync.pyguards the install lines and theCITATION.cffversion. It never saw this one.The claim is gone rather than corrected.
CHANGELOG.mdalready carries the release timeline, and a second copy of a version number is a second thing to drift.What else changed
pip installlinesWhat it doesandWhat this is — and isn'toverlapped, so they merged into one section. The three analytical layers lose their numbered subsection headings and keep every field name.What did not change, and why
test_docs_sync.pyholds the README to three contracts:commoner-analyse <cmd>names a real subcommandAll three still pass. The label list and the output-layout block are carried through verbatim by the rewrite rather than retyped, so no label or filename can drift in this PR.
Checks
notes/,_org/, HANDOFF, WORKING) in the file