Skip to content

Commit aac3d1f

Browse files
committed
Update docs
1 parent d81120e commit aac3d1f

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

marrow/src/array.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use half::f16;
33

44
use crate::datatypes::{FieldMeta, TimeUnit};
55

6-
/// An owned array
6+
/// An array with owned data
77
#[derive(Clone, Debug)]
88
#[non_exhaustive]
99
pub enum Array {

marrow/src/datatypes.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::collections::HashMap;
33

44
use crate::error::{fail, ErrorKind, MarrowError, Result};
55

6-
/// The metadata of a field
6+
/// The data type and metadata of a field
77
#[derive(Debug, Clone, PartialEq, Eq)]
88
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
99
pub struct Field {
@@ -37,7 +37,7 @@ pub(crate) fn meta_from_field(field: Field) -> FieldMeta {
3737
}
3838
}
3939

40-
/// Supported data types
40+
/// Data types of array
4141
///
4242
#[cfg_attr(
4343
// arrow-version: replace: feature = "arrow-{version}",

marrow/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
//!
1414
//! - [`Array`][crate::array::Array]: an array with owned data
1515
//! - [`View`][crate::view::View]: an array with borrowed data
16-
//! - [`Field`][crate::datatypes::Field]: field metadata
17-
//! - [`DataType`][crate::datatypes::DataType]: field data types
16+
//! - [`Field`][crate::datatypes::Field]: the data type and metadata of a field
17+
//! - [`DataType`][crate::datatypes::DataType]: data types of array
1818
//!
1919
//! ## Conversions
2020
//!

marrow/src/view.rs

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ use half::f16;
55

66
use crate::datatypes::{FieldMeta, TimeUnit};
77

8+
/// An array with borrowed data
9+
///
810
/// See [`Array`][crate::array::Array]
911
#[derive(Clone, Debug)]
1012
#[non_exhaustive]

0 commit comments

Comments
 (0)