Skip to content

Commit 065151b

Browse files
authored
fix: invalid examples/documentation in parquet_derive doc (#5823)
* fix: the previous example doesnot work * chore: change code from ignore to no-run * chore: Remove dependency * chore: format * chore * chore
1 parent fe071eb commit 065151b

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

parquet_derive/src/lib.rs

+12-4
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,13 @@ mod parquet_field;
3939
///
4040
/// Example:
4141
///
42-
/// ```ignore
42+
/// ```no_run
43+
/// use parquet_derive::ParquetRecordWriter;
44+
/// use std::io::{self, Write};
4345
/// use parquet::file::properties::WriterProperties;
4446
/// use parquet::file::writer::SerializedFileWriter;
47+
/// use parquet::record::RecordWriter;
48+
/// use std::fs::File;
4549
///
4650
/// use std::sync::Arc;
4751
///
@@ -62,14 +66,15 @@ mod parquet_field;
6266
/// a_str: "I'm false"
6367
/// }
6468
/// ];
69+
/// let file = File::open("some_file.parquet").unwrap();
6570
///
66-
/// let schema = samples.as_slice().schema();
71+
/// let schema = samples.as_slice().schema().unwrap();
6772
///
6873
/// let mut writer = SerializedFileWriter::new(file, schema, Default::default()).unwrap();
6974
///
7075
/// let mut row_group = writer.next_row_group().unwrap();
7176
/// samples.as_slice().write_to_row_group(&mut row_group).unwrap();
72-
/// writer.close_row_group(row_group).unwrap();
77+
/// row_group.close().unwrap();
7378
/// writer.close().unwrap();
7479
/// }
7580
/// ```
@@ -148,9 +153,11 @@ pub fn parquet_record_writer(input: proc_macro::TokenStream) -> proc_macro::Toke
148153
///
149154
/// Example:
150155
///
151-
/// ```ignore
156+
/// ```no_run
157+
/// use parquet::record::RecordReader;
152158
/// use parquet::file::{serialized_reader::SerializedFileReader, reader::FileReader};
153159
/// use parquet_derive::{ParquetRecordReader};
160+
/// use std::fs::File;
154161
///
155162
/// #[derive(ParquetRecordReader)]
156163
/// struct ACompleteRecord {
@@ -160,6 +167,7 @@ pub fn parquet_record_writer(input: proc_macro::TokenStream) -> proc_macro::Toke
160167
///
161168
/// pub fn read_some_records() -> Vec<ACompleteRecord> {
162169
/// let mut samples: Vec<ACompleteRecord> = Vec::new();
170+
/// let file = File::open("some_file.parquet").unwrap();
163171
///
164172
/// let reader = SerializedFileReader::new(file).unwrap();
165173
/// let mut row_group = reader.get_row_group(0).unwrap();

0 commit comments

Comments
 (0)