fix(templates): keep cross-referenced types clickable in tables - #129
Merged
Conversation
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.
Follows up @gkodinov's point on #127, which turned out to be a rendering bug rather than only a missing feature.
A parameter whose type is another documented symbol was rendered as:
A link cannot live inside a code span, so readers saw the raw link syntax. Referenced types now keep the link and style the symbol the way
linkedNamealready styles names elsewhere:Types with no reference are untouched and stay fully inline code. Return types in member summary tables link too, via the same helper, so there is one behaviour rather than two.
returnTypeShortis kept and delegates to the newtypeCellhelper, so templates copied fromtemplates/cppkeep working and pick up the fix.Covered by a real fixture case (a documented struct used as a parameter and return type) plus unit tests. Also fixed the unit test harness, which compiled its local template without
noEscapeand so did not match howloadTemplatescompiles the real ones.Bundles the 2.1.16 bump.