-
Notifications
You must be signed in to change notification settings - Fork 312
Remove unnecessary ignore
attribute in doc.
#1504
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR removes the unnecessary ignore
attribute from Rust code examples in the documentation and updates the import path for MemoryCatalog
to reference the iceberg
crate.
- Removed
ignore
attribute from two fenced code blocks - Updated
use crate::MemoryCatalog;
touse iceberg::MemoryCatalog;
Comments suppressed due to low confidence (4)
crates/iceberg/src/writer/mod.rs:41
- Removing
ignore
will make these examples compiled and run as doc tests, but they depend on theiceberg-catalog-memory
crate which isn’t enabled by default. Consider usingrust,no_run
(rust,no_run
) or gating the examples behind a Cargo feature to avoid CI failures.
//! ```rust
crates/iceberg/src/writer/mod.rs:100
- This fenced code block was similarly un-ignored. It will now be built as a doc test and fail without the
iceberg-catalog-memory
feature. Userust,no_run
or revert toignore
, or gate it behind a feature.
//! ```rust
crates/iceberg/src/writer/mod.rs:58
- The
MemoryCatalog
type lives in theiceberg_catalog_memory
crate, not directly iniceberg
. Update this import touse iceberg_catalog_memory::MemoryCatalog
or re-export it through the main crate.
//! use iceberg::MemoryCatalog;
crates/iceberg/src/writer/mod.rs:115
- Same as above:
MemoryCatalog
isn’t in theiceberg
crate root. Change touse iceberg_catalog_memory::MemoryCatalog
or ensure it’s re-exported properly.
//! use iceberg::MemoryCatalog;
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
The previous PR made 3 changes to rust, ignore
. 2 are captured by this PR already.
The third is here. Should we change this too?
Thanks for pointing out, done. |
## Which issue does this PR close? - Closes apache#1503 . ## What changes are included in this PR? Fix doc and remove unnecessary `ignore` attribute in doc. ## Are these changes tested? CI.
Which issue does this PR close?
ignore
attribute iniceberg
crate's doc. #1503 .What changes are included in this PR?
Fix doc and remove unnecessary
ignore
attribute in doc.Are these changes tested?
CI.