Skip to content

Commit 1e75ab6

Browse files
committed
Document NdProducer::raw_dim
This is useful because, otherwise, users have to manually calculate the shape of the producer to e.g. allocate an array of the correct shape to zip with it.
1 parent 9a4184b commit 1e75ab6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/zip/ndproducer.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ pub trait NdProducer {
7272

7373
#[doc(hidden)]
7474
fn layout(&self) -> Layout;
75-
#[doc(hidden)]
75+
/// Return the shape of the producer.
7676
fn raw_dim(&self) -> Self::Dim;
7777
#[doc(hidden)]
7878
fn equal_dim(&self, dim: &Self::Dim) -> bool {

0 commit comments

Comments
 (0)