docs: add markdown.py to STRUCTURE.md [doc-updater] - #3131
Conversation
Update documentation to reflect changes from a45cbaf (Unwrap PR-body soft breaks + cross-link slice PRs from the context PR, #3122/#3128): - Add markdown.py to the egg_contracts/ file listing in STRUCTURE.md - Add test_markdown.py to the tests/shared/egg_contracts/ listing The commit added a new shared/egg_contracts/markdown.py module (unwrap_soft_breaks) and its tests but did not update STRUCTURE.md. Triggered by: #3128 Authored-by: egg
There was a problem hiding this comment.
LGTM. Targeted, accurate, and consistent with the surrounding STRUCTURE.md style.
Verified:
shared/egg_contracts/markdown.pyexists and matches the one-line description —unwrap_soft_breaksis the public helper, #3122 is the originating issue, and the comment about "pipeline-generated PR bodies" matches the module docstring atshared/egg_contracts/markdown.py:1-29.tests/shared/egg_contracts/test_markdown.pyexists and is the corresponding test module.- Both new entries are placed just before
redactor.py/test_redactor.py, matching the file-then-test ordering used elsewhere in the section. - a45cbaf is the correct parent commit (the squash of #3128 onto main).
Non-blocking observation (out of scope for this PR): the egg_contracts/ and tests/shared/egg_contracts/ tables in STRUCTURE.md are already incomplete — modules like loader.py, validator.py, decisions.py, feedback.py, hitl.py, roles.py, audit.py, resilience.py, impasse.py, and several test files exist on disk but are not enumerated. That's pre-existing drift the doc-updater agent didn't introduce, and bundling a backfill into this PR would muddy a clean two-line follow-up. Worth filing as its own issue if the intent of STRUCTURE.md is exhaustive coverage.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
Review feedback dispositionThanks for the LGTM and the careful verification. Items
No code changes in this round — the LGTM stands and this PR remains the clean two-line fix the reviewer endorsed. — Authored by egg |
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
Backfill pre-existing drift in the egg_contracts/ listings flagged during review of #3131: - shared/egg_contracts/: add 10 missing source modules (the 9 from #3132 plus artifact_spec.py, which the issue missed) - tests/shared/egg_contracts/: add the 13 missing test modules - shared/egg_contracts/tests/: enumerate the previously-undocumented in-package test suite (11 modules) - preamble: state that listings are intended exhaustive unless explicitly truncated with ..., resolving the HITL question in #3132 Closes #3132
Update documentation to reflect changes from a45cbaf (Unwrap PR-body soft breaks + cross-link slice PRs from the context PR, #3122/#3128).
The commit added
shared/egg_contracts/markdown.py(theunwrap_soft_breakshelper) andtests/shared/egg_contracts/test_markdown.pybut did not updatedocs/development/STRUCTURE.md, which enumerates all files inegg_contracts/and the shared test tree.Changes:
markdown.pyentry to theegg_contracts/file listingtest_markdown.pyentry to thetests/shared/egg_contracts/listingTriggered by: #3128
Test Plan
Authored-by: egg