chore(render): split markdown renderer into modules#44
Open
Wpelletier01 wants to merge 1 commit intoMetbcy:mainfrom
Open
chore(render): split markdown renderer into modules#44Wpelletier01 wants to merge 1 commit intoMetbcy:mainfrom
Wpelletier01 wants to merge 1 commit intoMetbcy:mainfrom
Conversation
Keep the markdown renderer easier to maintain by separating each output section into focused modules without changing the public rendering API.
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.
What this PR does
Keep the markdown renderer easier to maintain by separating each output section into focused modules without changing the public rendering API.
The existing renderer tests were moved alongside their section modules so each file stays smaller and easier to review, including respecting the 25 KB size limit.
Test coverage
No new behavior was added. Existing markdown renderer unit coverage was preserved and split into the relevant module files with the implementation.
Verification gates
cargo fmt --all --checkcleancargo clippy --all-targets --all-features -- -D warningscleancargo test --releasecleanbash examples/run-all.shclean (if behavior or rendered-output changes touched the example fixtures)mdbook build docsclean (if anydocs/src/**.mdchanged)bash examples/run-all.shis not clean because the pinned example outputs are not up to date. The current renderer emits theMaintainer set changedsummary row and detail section, butexamples/*/expected-output.mdstill reflects the older output shape.Linked issues
#30