Skip to content

ci: resolve rustdoc warnings and add CI check#5428

Merged
wjones127 merged 2 commits intolance-format:mainfrom
wjones127:fix-rustdoc-warnings
Dec 8, 2025
Merged

ci: resolve rustdoc warnings and add CI check#5428
wjones127 merged 2 commits intolance-format:mainfrom
wjones127:fix-rustdoc-warnings

Conversation

@wjones127
Copy link
Copy Markdown
Contributor

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

wjones127 and others added 2 commits December 7, 2025 14:15
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>
@github-actions github-actions Bot added the bug Something isn't working label Dec 7, 2025
@wjones127 wjones127 changed the title fix: resolve rustdoc warnings and add CI check ci: resolve rustdoc warnings and add CI check Dec 7, 2025
@wjones127 wjones127 removed the bug Something isn't working label Dec 7, 2025
@github-actions github-actions Bot added the ci Github Action or Test issues label Dec 7, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@wjones127 wjones127 marked this pull request as ready for review December 7, 2025 22:54
Copy link
Copy Markdown
Collaborator

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this

@wjones127 wjones127 merged commit 526a9ba into lance-format:main Dec 8, 2025
28 of 29 checks passed
@wjones127 wjones127 deleted the fix-rustdoc-warnings branch December 8, 2025 05:36
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Github Action or Test issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants