This is an automated email from the ASF dual-hosted git repository.
etseidl pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 25ff46fb5d [Minor] Hide thrift macros (#8616)
25ff46fb5d is described below
commit 25ff46fb5d5bc1004b923871d27a5615e26e02f0
Author: Ed Seidl <[email protected]>
AuthorDate: Thu Oct 16 07:03:00 2025 -0700
[Minor] Hide thrift macros (#8616)
# Which issue does this PR close?
None
# Rationale for this change
While rendering the docs I noticed the thrift macros were exposed.
# What changes are included in this PR?
Add `#[doc(hidden)]` to all thrift macros.
# Are these changes tested?
None needed
# Are there any user-facing changes?
No, just documentation
---
parquet/src/parquet_macros.rs | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/parquet/src/parquet_macros.rs b/parquet/src/parquet_macros.rs
index 80dc9658c0..22c61df36a 100644
--- a/parquet/src/parquet_macros.rs
+++ b/parquet/src/parquet_macros.rs
@@ -31,6 +31,7 @@
//! [Thrift compact]:
https://github.com/apache/thrift/blob/master/doc/specs/thrift-compact-protocol.md#list-and-set
//! [THRIFT.md]: https://github.com/apache/arrow-rs/blob/main/parquet/THRIFT.md
+#[doc(hidden)]
#[macro_export]
#[allow(clippy::crate_in_macro_def)]
/// Macro used to generate rust enums from a Thrift `enum` definition.
@@ -91,6 +92,7 @@ macro_rules! thrift_enum {
/// The resulting Rust enum will have all unit variants.
///
/// When utilizing this macro the Thrift serialization traits and structs need
to be in scope.
+#[doc(hidden)]
#[macro_export]
#[allow(clippy::crate_in_macro_def)]
macro_rules! thrift_union_all_empty {
@@ -163,6 +165,7 @@ macro_rules! thrift_union_all_empty {
/// This macro allows for specifying lifetime annotations for the resulting
`enum` and its fields.
///
/// When utilizing this macro the Thrift serialization traits and structs need
to be in scope.
+#[doc(hidden)]
#[macro_export]
#[allow(clippy::crate_in_macro_def)]
macro_rules! thrift_union {
@@ -228,6 +231,7 @@ macro_rules! thrift_union {
/// This macro allows for specifying lifetime annotations for the resulting
`struct` and its fields.
///
/// When utilizing this macro the Thrift serialization traits and structs need
to be in scope.
+#[doc(hidden)]
#[macro_export]
macro_rules! thrift_struct {
($(#[$($def_attrs:tt)*])* $vis:vis struct $identifier:ident $(<
$lt:lifetime >)? { $($(#[$($field_attrs:tt)*])* $field_id:literal :
$required_or_optional:ident $field_type:ident $(< $field_lt:lifetime >)? $(<
$element_type:ident >)? $field_name:ident $(= $default_value:literal)? $(;)?)*
}) => {
