ci: resolve rustdoc warnings and add CI check#5428
Merged
wjones127 merged 2 commits intolance-format:mainfrom Dec 8, 2025
Merged
ci: resolve rustdoc warnings and add CI check#5428wjones127 merged 2 commits intolance-format:mainfrom
wjones127 merged 2 commits intolance-format:mainfrom
Conversation
Fix documentation issues that trigger warnings when building with `RUSTDOCFLAGS="-D warnings"`: - Escape generic types in doc comments (e.g., `Vec<T>`, `List<u8>`) - Fix broken intra-doc links to private/non-existent items - Wrap bare URLs in angle brackets - Fix unclosed HTML tags from generic type syntax - Change invalid code block markers in proto files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add a CI job that runs `cargo doc` with warnings treated as errors to prevent documentation issues from being introduced. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
jackye1995
pushed a commit
to jackye1995/lance
that referenced
this pull request
Jan 21, 2026
## Summary - Fix documentation issues that trigger warnings when building with `RUSTDOCFLAGS="-D warnings"` - Add a CI job that runs `cargo doc` with warnings treated as errors to prevent future regressions ### Documentation fixes include: - Escape generic types in doc comments (e.g., `Vec<T>`, `List<u8>`) - Fix broken intra-doc links to private/non-existent items - Wrap bare URLs in angle brackets - Fix unclosed HTML tags from generic type syntax - Change invalid code block markers in proto files 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
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
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.
Summary
RUSTDOCFLAGS="-D warnings"cargo docwith warnings treated as errors to prevent future regressionsDocumentation fixes include:
Vec<T>,List<u8>)🤖 Generated with Claude Code