Skip to content

doc: run doc test#1066

Closed
de-sh wants to merge 2 commits into
apache:mainfrom
de-sh:main
Closed

doc: run doc test#1066
de-sh wants to merge 2 commits into
apache:mainfrom
de-sh:main

Conversation

@de-sh

@de-sh de-sh commented Mar 10, 2025

Copy link
Copy Markdown

Which issue does this PR close?

What changes are included in this PR?

  • Ensures an example using the writer in docs is run as part of test.

Are these changes tested?

@@ -26,23 +26,58 @@
//! 2. IcebergWriter: Focus on the logical format of iceberg table. It will write the data using the FileWriter finally.
//!
//! # Simple example for data file writer:

@Fokko Fokko Mar 10, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we put this example under the examples crate? Otherwise it might go out of sync again soon

https://github.com/apache/iceberg-rust/tree/main/crates/examples/src

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In #999 we added rust, no_run to the example fragement, so it will compile without running during build

@liurenjie1024

Copy link
Copy Markdown
Contributor

Thanks @de-sh , it duplicates with #999 , should we close this now?

@de-sh de-sh closed this Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants