[5.9] Respect formatting of links to symbols using custom titles #651
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
Contributor
mportiz08
commented
May 9, 2023
mportiz08
commented
- Explanation: Fixes bug where code voice is incorrectly applied to links with custom titles/formatting which point to symbols. Now the inline formatting of the custom links will be respected as-is.
- Scope: Impacts all DocC links with custom titles/formatting
- Issue: rdar://108515663
- Risk: Low, added flag/logic for links with custom titles
- Testing: Added/updated unit tests and manually tested various kinds of DocC links to verify that the formatting is appropriate.
- Reviewer: @dobromir-hristov and @marinaaisa
- Original PR: Respect formatting of links to symbols using custom titles #647
…#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
franklinsch
approved these changes
May 11, 2023
|
@swift-ci test |
mportiz08
deleted the
5.9/dont-apply-code-element-to-refs-with-inline-formatting
branch
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.