Deny broken doc comments (and fix a few warnings) - #1212
Merged
Conversation
While we tested that doc comments *built*, which checks example code is syntactically valid, calls items that exist, etc we did not actually deny warnings when checking doc comments. Typically, one might see those warnings and fix them, and in practice the doc comments in Propolis and the related crates all build without issue. Over time some issues do creep in though, and we might as well catch and reject them in CI to keep things tidy. Otherwise the warnings end up in CI logs that likely no one is checking...
zeeshanlakhani
approved these changes
Sep 9, 2026
zeeshanlakhani
added a commit
that referenced
this pull request
Sep 9, 2026
- merge in #1212 when accepted.
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.
While we tested that doc comments built, which checks example code is syntactically valid, calls items that exist, etc we did not actually deny warnings when checking doc comments.
Typically, one might see those warnings and fix them, and in practice the doc comments in Propolis and the related crates all build without issue. Over time some issues do creep in though, and we might as well catch and reject them in CI to keep things tidy. Otherwise the warnings end up in CI logs that likely no one is checking...
this is mostly me peeling out the unrelated docs cleanup from #1210 into its own change and fixing the underlying issue that let these warnings creep in over time :)