iceboundrock / iceboundrock/AutoForge
[AF-DOC-001] README and docstrings overstate current guarantees
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 8h 56m
- Merged PRs (30d)
- 40
Description
Severity: LOW · Area: documentation
Problem
Several statements overstate current guarantees:
README.md: "corrupted state is never silently overwritten" — contradicted byrunbehaviour (#11).README.md/transitions.pydocstring: "all transition logic lives in transitions.py" — the engine decides in_verify_and_apply;decide_next_phaseis dead (#2).README.md: "every claim is verified" — MERGE / UPDATE_EPIC are unverified (#3, #13).state.pyfrom_dictcomment says "ignore nothing" while the code drops unknown keys (#7 item 2).
README does correctly state that MERGE / UPDATE_EPIC are "not exercised" in this milestone.
Recommended fix
Either fix the code first and keep the sentences, or amend the sentences now to describe the milestone accurately. Close this once each referenced issue lands or the text is corrected.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the four statements in README.md, then inspect the transitions.py docstring and state.py from_dict comment alongside issues #2, #3, #7, #11, and #13. Confirm which guarantees the current milestone supports. Done means each statement is corrected to match current behavior, or the referenced implementation issues have landed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100