fix: invalid examples/documentation in parquet_derive doc #5823
Conversation
This file contains 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
|
Perhaps we could change |
Weijun-H
force-pushed
the
fix-parquet-eample
branch
from
7917561 to
a66cd13
Compare
Weijun-H
force-pushed
the
fix-parquet-eample
branch
from
ba9f319 to
604da73
Compare
tustvold
reviewed
May 31, 2024
parquet_derive/src/lib.rs
Outdated
| @@ -160,6 +167,7 @@ pub fn parquet_record_writer(input: proc_macro::TokenStream) -> proc_macro::Toke | |||
| /// | |||
| /// pub fn read_some_records() -> Vec<ACompleteRecord> { | |||
| /// let mut samples: Vec<ACompleteRecord> = Vec::new(); | |||
| /// let mut file = tempfile().unwrap(); | |||
There was a problem hiding this comment.
Suggested change
| /// let mut file = tempfile().unwrap(); | |
| /// let mut file = todo!(); |
And same above, would avoid a dependency
There was a problem hiding this comment.
It does not work.
error[E0277]: the trait bound `(): std::io::Write` is not satisfied
--> parquet_derive/src/lib.rs:73:19
|
34 | let mut writer = SerializedFileWriter::new(file, schema, Default::default()).unwrap();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `std::io::Write` is not implemented for `()`
|
note: required by a bound in `SerializedFileWriter`
--> /Users/hwj/Desktop/rust/arrow-rs/parquet/src/file/writer.rs:141:36
|
141 | pub struct SerializedFileWriter<W: Write> {
| ^^^^^ required by this bound in `SerializedFileWriter`There was a problem hiding this comment.
I use std::fs::File to avoid a dependency
tustvold
approved these changes
Jun 1, 2024
parquet_derive/src/lib.rs
Outdated
| @@ -160,6 +167,7 @@ pub fn parquet_record_writer(input: proc_macro::TokenStream) -> proc_macro::Toke | |||
| /// | |||
| /// pub fn read_some_records() -> Vec<ACompleteRecord> { | |||
| /// let mut samples: Vec<ACompleteRecord> = Vec::new(); | |||
| /// let mut file = File::open("some_file.parquet").unwrap(); | |||
There was a problem hiding this comment.
I suspect the mut is unnecessary
parquet_derive/src/lib.rs
Outdated
| @@ -62,14 +66,15 @@ mod parquet_field; | |||
| /// a_str: "I'm false" | |||
| /// } | |||
| /// ]; | |||
| /// let mut file = File::open("some_file.parquet").unwrap(); | |||
There was a problem hiding this comment.
I suspect the mut is unnecessary
alamb
added
documentation
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.
Which issue does this PR close?
Closes #5687
Rationale for this change
What changes are included in this PR?
Are there any user-facing changes?