[5.7] Check the module name to know when to skip inherited doc comments. #316
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
d-ronnqvist
commented
Jun 21, 2022
d-ronnqvist
commented
- Rationale: This is—together with the two other parts—fix an issue where documentation comments that are inherited from other modules may raise non-actionable warnings if the original documentation comment linked to other symbols in that module.
- Risk: Low
- Risk Detail: This uses the new API from [5.7] Decode the new docComment module and file information swift-docc-symbolkit#43 to more reliably determine if inherited documentation comments originate from another module or from the current module.
- Reward: Medium
- Reward Details: Documentation builds successfully but documentation for protocol conformance symbols from other modules may render with broken links to symbols.
- Original PR: Check the module name to know when to skip inherited doc comments. #314
- Issue: rdar://92185538
- Code Reviewed By: @QuietMisdreavus
- Testing Details: See Check the module name to know when to skip inherited doc comments. #314
…wiftlang#314) * Check the module name to know when to skip inherited doc comments. * Fallback to the previous logic when the new doc comment info is missing * Use new function in SymbolKit that handles older symbol graph versions * Use merged version of SymbolKit changes
franklinsch
approved these changes
Jun 22, 2022
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test |
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.