Repository navigation
Fix the no_std rustdoc links, and build the no_std docs in CI - #1643
Conversation
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 73430e6f0f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
73430e6 to
a9955b0
Compare
The docs built without std had 25 unresolved links. Links to BTreeMap, its cursors and entry, and RangeBounds now point into alloc and core, which exist in both builds. Links to std-only items are reworded, and the file-specific details in the docs of open_read_only_with_backend() are removed. CI and `just build_no_std` now build the no_std docs with warnings denied. Assisted-by: Claude Code Claude-Session: https://claude.ai/code/session_01ALhxet6NP69dCfAUv8TAhR
a9955b0 to
025e6dd
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 025e6dd3d3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
lgtm |
cargo doc --target thumbv7em-none-eabihf --no-default-features --features experimental-api-5reported 25 unresolved intra-doc links. No build generated these docs, so the count only grew. This fixes all of them and adds that build to CI with warnings denied.The 25 links:
std::collections/std::ops.BTreeMap::{entry, lower_bound, upper_bound, ...},btree_map::{Entry, Cursor, CursorMut}and their methods, andRangeBoundsnow link intoalloc::collections/core::ops. Those exist in both builds, so the std docs keep the same links.experimental-api-5.[BTreeMap::entry]in the text, with the target at the end of the doc block), so the prose lines are unchanged. The displayed text drops thestd::collections::prefix.StorageBackenddocs: thestd::io::Errormention links by URL.BackendError::Io": now "with an error other thanBackendError::Unsupported". That is the distinction that matters for fallback, andIodoesn't exist without std.RepairSession::abort: said "the corresponding call toBuilder::openorBuilder::create", and misspelled "corresponding". It now says the open returnsDatabaseError::RepairAborted.set_check_integrity_on_open: now says the check "does not apply to read-only opens", instead of namingopen_read_only.open_read_only_with_backend()(open_read_onlyrules,FileBackend,File::try_clone).FileBackend/File::try_cloneparagraph is removed.open_read_only's locking and concurrency rules also apply is kept, with the method name as plain code instead of a link.CI and justfile: the no_std step in CI, and
just build_no_std, now run thatcargo docwithRUSTDOCFLAGS="--deny warnings". On master that command fails with 25 errors.Checked:
cargo docwith zero warnings for no_std, std with all features, and std with default features.cargo fmt.🤖 Generated with Claude Code
https://claude.ai/code/session_01ALhxet6NP69dCfAUv8TAhR