Skip to content
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.

Sign up for GitHub

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

Minor: clarify the relationship between file::metadata and format in docs #6049

Merged
merged 1 commit into from
Jul 16, 2024
Merged

Minor: clarify the relationship between file::metadata and format in docs #6049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion parquet/src/file/metadata/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
// specific language governing permissions and limitations
// under the License.

//! Parquet metadata structures
//! Parquet metadata API
//!
//! Most users should use these structures to interact with Parquet metadata.
//! The [crate::format] module contains lower level structures generated from the
//! Parquet thrift definition.
//!
//! * [`ParquetMetaData`]: Top level metadata container, read from the Parquet
//! file footer.
Expand Down
2 changes: 1 addition & 1 deletion parquet/src/file/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// specific language governing permissions and limitations
// under the License.

//! Low level APIs for reading raw parquet data.
//! APIs for reading parquet data.
//!
//! Provides access to file and row group readers and writers, record API, metadata, etc.
//!
Expand Down
7 changes: 6 additions & 1 deletion parquet/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,12 @@ macro_rules! experimental {
pub mod errors;
pub mod basic;

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