Repository navigation
docs(rust): show with_execution_deadline in the API docs - #63
Merged
Merged
Conversation
The function was made a documented public API, but its re-export in the query module still carried #[doc(hidden)], so docs.rs left it out. Remove the attribute so the next release lists it.
Deploying lance-csr with
|
| Latest commit: |
a2bbee5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8626d7a1.lance-csr.pages.dev |
| Branch Preview URL: | https://docs-show-execution-deadline.lance-csr.pages.dev |
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.
Why
lance_csr::query::with_execution_deadlinebecame a documented public API in #55, and the Rust guide describes it. But its re-export in thequerymodule still had#[doc(hidden)], so the API docs on docs.rs for 0.3.0 and 0.3.1 leave it out. The function itself is public and works.What changed
#[doc(hidden)]from the re-export, so rustdoc generatesquery/fn.with_execution_deadline.html. docs.rs picks it up with the next published version.Validation
cargo doc -p lance-csrnow generates the page.cargo clippy --workspace --all-targets -- -D warningsand the doctests pass, including the function's own example.🤖 Generated with Claude Code