From 1e75ab68afa7676e1e2c28d74a22a87b03371fdc Mon Sep 17 00:00:00 2001
From: Jim Turner <github@turner.link>
Date: Mon, 15 Feb 2021 18:38:26 -0500
Subject: [PATCH] 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.
---
 src/zip/ndproducer.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/zip/ndproducer.rs b/src/zip/ndproducer.rs
index b6df10f51..7c201741c 100644
--- a/src/zip/ndproducer.rs
+++ b/src/zip/ndproducer.rs
@@ -72,7 +72,7 @@ pub trait NdProducer {
 
     #[doc(hidden)]
     fn layout(&self) -> Layout;
-    #[doc(hidden)]
+    /// Return the shape of the producer.
     fn raw_dim(&self) -> Self::Dim;
     #[doc(hidden)]
     fn equal_dim(&self, dim: &Self::Dim) -> bool {