Add CI job to run cargo doc on the bindings crate
#2548
Merged
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
This requires hiding `Filter` behind the feature flag, in addition to the `client_visibility_filter` macro, since the doc comment for `Filter` links to the macro. `Filter` is not useful outside of its connection with the macro, so feature-gating it seems fine.
bfops
approved these changes
Apr 3, 2025
Collaborator
bfops
left a comment
bfops
left a comment
There was a problem hiding this comment.
The CI part LGTM. If the other changes make it pass, I assume they're correct too 👍
Contributor
Author
|
From a commit message:
|
joshua-spacetime
approved these changes
Apr 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of Changes
Like the title says. I noticed we had some broken links in doc comments while working on #2547 , and thought it would be wise to detect them in CI.
API and ABI breaking changes
N/a.
Expected complexity level and risk
Testing