Skip to content

Commit

Permalink
Update module description.
Browse files Browse the repository at this point in the history
  • Loading branch information
WhyAreAllTheseTaken committed Jan 15, 2024
1 parent 8468764 commit c121dd3
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
//! A crate providing statically sized, heap allocated arrays without requiring a copy from the
//! stack for array creation.
//! A no-std rust crate providing a heap-allocated non-resizable type-checked array.
// !
//! The following types are provided:
//! - `HeapArray` - A one dimensional heap-allocated array.
//! - `HeapArray2D` - A two dimensional heap-allocated array.
//! - `HeapArray3D` - A three dimensional heap-allocated array.
//!
//! This crate does not depend on `std` but does require `alloc` in order to create the array.
//!
//! # Examples
//! ## Creating a large array on the heap using a function.
Expand Down

0 comments on commit c121dd3

Please sign in to comment.