Cleanup user docs #85026
Merged
Cleanup user docs #85026
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
Moves all the "diagnostic descriptions" into "diagnostic groups". This then allows some additional handling for: 1. Error when diagnostic files and their definition in `DiagnosticGroups.def` don't match up 2. Error when a title is missing its group name 3. List of all groups with warnings
Also adds a parent `RegionIsolation` group to link both `SendingRisksDataRace` and the newly added `SendingClosureRisksDataRace`.
This is mostly just cleanup: 1. Removes `diagnostic-descriptions.md` since it isn't used any more 2. Adds the group name to all the old notes files 3. Removes trailing whitespace 4. Adds "See Also" sections for notes that have links
bnbarham
commented
Oct 21, 2025
| func generateIndex() throws { | ||
| let notesHandle = try createIndex(name: notesDocFileName, header: notesHeader) | ||
| defer { try? notesHandle.close() } | ||
| let groupsWithWarnings = try groupNamesWithWarnings() |
There was a problem hiding this comment.
Interested in opinions as to whether this is actually worth doing or not. We could potentially include the parent hierarchy in here as well.
There was a problem hiding this comment.
I like this. I would also like the parent hierarchy, because I expect it will help us as we get more diagnostic groups in place.
There was a problem hiding this comment.
Yeah makes sense, I can look at that next 🙇
|
@swift-ci please smoke test |
owenv
approved these changes
Oct 21, 2025
|
@swift-ci please clean smoke test macOS platform |
DougGregor
approved these changes
Oct 23, 2025
| func generateIndex() throws { | ||
| let notesHandle = try createIndex(name: notesDocFileName, header: notesHeader) | ||
| defer { try? notesHandle.close() } | ||
| let groupsWithWarnings = try groupNamesWithWarnings() |
There was a problem hiding this comment.
I like this. I would also like the parent hierarchy, because I expect it will help us as we get more diagnostic groups in place.
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.
The core change here is the update to
generate-doc-index, which now groups all diagnostic groups together rather than separating them into "descriptions" and "groups". That allows for some extra handling:DiagnosticGroups.defdon't match upThe rest is small cleanups to the old notes files - adding their group name in and adding
See Alsosections where that makes sense. Also updated some of the links to the new TSPL links rather than the old (which takes a little while to redirect and not always to the correct location).