Skip to content

docs: add markdown.py to STRUCTURE.md [doc-updater] - #3131

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-egg-contracts-markdown
Jun 11, 2026
Merged

docs: add markdown.py to STRUCTURE.md [doc-updater]#3131
jwbron merged 1 commit into
mainfrom
egg/doc-update-egg-contracts-markdown

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

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 (the unwrap_soft_breaks helper) and tests/shared/egg_contracts/test_markdown.py but did not update docs/development/STRUCTURE.md, which enumerates all files in egg_contracts/ and the shared test tree.

Changes:

  • Add markdown.py entry to the egg_contracts/ file listing
  • Add test_markdown.py entry to the tests/shared/egg_contracts/ listing

Triggered by: #3128

Test Plan

  • Automated: no tests for docs; change is additive (two lines added to STRUCTURE.md)
  • Manual: verify the two new entries appear in the shared-library table and test-tree table

Authored-by: egg

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

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Targeted, accurate, and consistent with the surrounding STRUCTURE.md style.

Verified:

  • shared/egg_contracts/markdown.py exists and matches the one-line description — unwrap_soft_breaks is the public helper, #3122 is the originating issue, and the comment about "pipeline-generated PR bodies" matches the module docstring at shared/egg_contracts/markdown.py:1-29.
  • tests/shared/egg_contracts/test_markdown.py exists 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

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author
egg is addressing review feedback...

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

Review feedback disposition

Thanks for the LGTM and the careful verification.

Items

  • STRUCTURE.md drift in egg_contracts/ and tests/shared/egg_contracts/ listingsdeferred-to #3132
    • The reviewer EXPLICITLY asked for a follow-up: "Worth filing as its own issue if the intent of STRUCTURE.md is exhaustive coverage." combined with "bundling a backfill into this PR would muddy a clean two-line follow-up."
    • The conditional ("if exhaustive coverage is the intent") is a HITL question — STRUCTURE.md's preamble doesn't state whether per-directory file listings should be exhaustive or curated, and that intent needs to be confirmed before doing the backfill (otherwise we may be solving the wrong problem). Filed STRUCTURE.md: backfill missing entries in egg_contracts/ and tests/shared/egg_contracts/ listings #3132 with the full inventory of missing entries and the design question framed for the maintainer.

No code changes in this round — the LGTM stands and this PR remains the clean two-line fix the reviewer endorsed.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg feedback addressed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit 186239b into main Jun 11, 2026
23 checks passed
jwbron added a commit that referenced this pull request Jun 12, 2026
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
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.

1 participant