This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new d9719d1f2d Fix field docs (#4563)
d9719d1f2d is described below
commit d9719d1f2d21ed0c75ffd5c8e8c4fb15ee5ebe54
Author: Raphael Taylor-Davies <[email protected]>
AuthorDate: Sat Jul 22 12:30:16 2023 -0400
Fix field docs (#4563)
---
arrow-schema/src/field.rs | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/arrow-schema/src/field.rs b/arrow-schema/src/field.rs
index f38e1e26ad..00deecf062 100644
--- a/arrow-schema/src/field.rs
+++ b/arrow-schema/src/field.rs
@@ -170,7 +170,7 @@ impl Field {
/// Create a new [`Field`] with [`DataType::Struct`]
///
- /// - `name`: the name of the [`DataType::List`] field
+ /// - `name`: the name of the [`DataType::Struct`] field
/// - `fields`: the description of each struct element
/// - `nullable`: if the [`DataType::Struct`] array is nullable
pub fn new_struct(
@@ -186,8 +186,6 @@ impl Field {
/// - `name`: the name of the [`DataType::List`] field
/// - `value`: the description of each list element
/// - `nullable`: if the [`DataType::List`] array is nullable
- ///
- /// Uses "item" as the name of the child field, this can be overridden
with [`Self::new`]
pub fn new_list(
name: impl Into<String>,
value: impl Into<FieldRef>,
