[Diagnostic formatting] Add a category footnote printer #3007
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
Categories associated with diagnostics are printed in a Markdown link style
as part of diagnostics (e.g., `[#StrictMemorySafety]`). At the end of
compilation, a tool may wish to provide documentation links to
documentation for all of the categories that showed up in that
compilation. This new function DiagnosticFormatter.categoryFootnotes()
prints the categories it is given (also as Markdown) for that purpose, e.g.,
[#deprecated]: <http://example.com/deprecated>
[#StrictMemorySafety]: <http://example.com/memory-safety>
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test Windows |
|
Speculatively merging; we can revise as needed |
ktoso
reviewed
Mar 10, 2025
| /// [#categoryName]: <categoryDocumentationURL> | ||
| /// ``` | ||
| /// | ||
| /// This function also deduplicates entries and alphabetizes the results. |
ahoppen
reviewed
Mar 10, 2025
| /// - leadingText: text that is prefixed to the list of categories when | ||
| /// there is at least one category to print. | ||
| public func categoryFootnotes( | ||
| _ categories: [DiagnosticCategory], |
There was a problem hiding this comment.
Could we make this some Collection<DiagnosticCategory>, say if somebody collected the categories in a Set (which doesn’t seem too unreasonable to me).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Categories associated with diagnostics are printed in a Markdown link style as part of diagnostics (e.g.,
[#StrictMemorySafety]). At the end of compilation, a tool may wish to provide documentation links to documentation for all of the categories that showed up in that compilation. This new function DiagnosticFormatter.categoryFootnotes() prints the categories it is given (also as Markdown) for that purpose, e.g.,