Skip to content

Commit b72098f

Browse files
authored
Minor: clarify the relationship between file::metadata and format (#6049)
1 parent b2458bd commit b72098f

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

parquet/src/file/metadata/mod.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
//! Parquet metadata structures
18+
//! Parquet metadata API
19+
//!
20+
//! Most users should use these structures to interact with Parquet metadata.
21+
//! The [crate::format] module contains lower level structures generated from the
22+
//! Parquet thrift definition.
1923
//!
2024
//! * [`ParquetMetaData`]: Top level metadata container, read from the Parquet
2125
//! file footer.

parquet/src/file/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
//! Low level APIs for reading raw parquet data.
18+
//! APIs for reading parquet data.
1919
//!
2020
//! Provides access to file and row group readers and writers, record API, metadata, etc.
2121
//!

parquet/src/lib.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,12 @@ macro_rules! experimental {
109109
pub mod errors;
110110
pub mod basic;
111111

112-
/// Automatically generated code for reading parquet thrift definition.
112+
/// Automatically generated code from the Parquet thrift definition.
113+
///
114+
/// This module code generated from [parquet.thrift]. See [crate::file] for
115+
/// more information on reading Parquet encoded data.
116+
///
117+
/// [parquet.thrift]: https://github.com/apache/parquet-format/blob/master/src/main/thrift/parquet.thrift
113118
// see parquet/CONTRIBUTING.md for instructions on regenerating
114119
#[allow(clippy::derivable_impls, clippy::match_single_binding)]
115120
// Don't try and format auto generated code

0 commit comments

Comments
 (0)