Merged
Conversation
Extract MkDocs-specific link formatting from TypeRenderer into a LinkFormat trait so multiple documentation backends can share the rendering logic. This is a prerequisite for adding an Info backend to pony-doc. Replace `generate_links: Bool` parameter with `(LinkFormat val | None)` across all 6 TypeRenderer methods. MkDocsBackend passes MkDocsLinkFormat where it previously passed true, and None where it passed false. Design: #5149
ponylang-main
added
the
discuss during sync
ponylang-main
removed
the
discuss during sync
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
2 participants
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.
Prerequisite refactor for adding an Info backend to pony-doc. Extracts
MkDocs-specific link formatting from TypeRenderer into a
LinkFormattrait so both the existing MkDocs backend and the upcoming Info backend
can share the same rendering logic.
Replaces
generate_links: Boolwith(LinkFormat val | None)acrossall 6 TypeRenderer methods.
_nominaluses a match-with-guard tocombine the format check and linkability check into a single branch.
MkDocsBackend call sites change mechanically:
truebecomesMkDocsLinkFormat,falsebecomesNone.Verified by diffing pony-doc output on the
collectionsstdlib packagebefore and after — identical output.
Design: #5149