Fix doc comments and verify in CI#383
Merged
davidkoski merged 3 commits intoml-explore:mainfrom Apr 3, 2026
Merged
Conversation
davidkoski
approved these changes
Apr 3, 2026
Collaborator
davidkoski
left a comment
davidkoski
left a comment
There was a problem hiding this comment.
Thank for the cleanup and the CI checker!
I may move the doc check into the lint runner as those are cheap time-wise. The macOS runners have limited capacity. Anyway, I will play around with that after the merge.
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
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.
I fixed many inaccurate doc comments and added a CI step that fails when inaccuracies in the doc comments are found. The CI step runs
swift package generate-documentation --target "$TARGET" --warnings-as-errorson each target.