Skip to content

Commit

Permalink
Add missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
juntyr committed Aug 5, 2024
1 parent 44180a0 commit 7b569c7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
3 changes: 3 additions & 0 deletions crates/numcodecs/src/array.rs
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,8 @@ where
}
}

/// Array-representation support for all dtypes included in [`AnyArrayBase`].
#[allow(missing_docs)]
pub trait AnyRawData {
type U8: RawData<Elem = u8>;
type U16: RawData<Elem = u16>;
Expand Down Expand Up @@ -319,6 +321,7 @@ impl<
type F64 = <T as RawDataSubst<f64>>::Output;
}

/// Enum of all dtypes included in [`AnyArrayBase`].
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
#[non_exhaustive]
#[allow(missing_docs)]
Expand Down
1 change: 1 addition & 0 deletions crates/numcodecs/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ mod array;

pub use array::{
AnyArcArray, AnyArray, AnyArrayBase, AnyArrayDType, AnyArrayView, AnyArrayViewMut, AnyCowArray,
AnyRawData,
};

/// Compression codec that [`encode`][`Codec::encode`]s and
Expand Down

0 comments on commit 7b569c7

Please sign in to comment.