Respect formatting of links to symbols using custom titles #647
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
3 tasks
marinaaisa
reviewed
May 9, 2023
dobromir-hristov
approved these changes
May 9, 2023
…t-to-refs-with-inline-formatting
|
@swift-ci test |
mportiz08
deleted the
dont-apply-code-element-to-refs-with-inline-formatting
branch
mportiz08
added a commit
to mportiz08/swift-docc-render
that referenced
this pull request
May 9, 2023
…#647) **Example:** ```markdown /// Default, should use code voice: ``StringBuilder`` /// /// Custom title, should use code voice: [`custom text`](doc:StringBuilder) /// /// Custom title, should not use code voice: [custom text](doc:StringBuilder) /// /// Custom title, should use italics and bold: [_**custom text**_](doc:StringBuilder) ``` Resolves: swiftlang#632 Resolves: rdar://108515663
mportiz08
added a commit
that referenced
this pull request
May 11, 2023
**Example:** ```markdown /// Default, should use code voice: ``StringBuilder`` /// /// Custom title, should use code voice: [`custom text`](doc:StringBuilder) /// /// Custom title, should not use code voice: [custom text](doc:StringBuilder) /// /// Custom title, should use italics and bold: [_**custom text**_](doc:StringBuilder) ``` Resolves: #632 Resolves: rdar://108515663
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.
Bug/issue #, if applicable: #632 (108515663)
Summary
This resolves #632, which is a bug where code voice is automatically applied to a symbol link that has a custom title, even if it doesn't use any code voice itself.
If a custom title is used for a markdown link to a DocC symbol, the inline markdown formatting of that title should be respected as-is.
Example:
Testing
Steps:
npm run buildAttributeExamples.zipwith custom title examples.env DOCC_HTML_DIR=/path/to/dist swift package --disable-sandbox preview-documentation --target AttributeExamplesto preview the example package with this branch of the renderer.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded