Minor array docs fixes

CHANGELOG.md

@@ -21,8 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  - Added `contiguous_elements` method to `ContiguousIndicesIterator` and `ContiguousLinearisedIndicesIterator`
  - Added `ChunkShape::num_elements`
  - Added `codec::CodecOptions{Builder}`
- - Added new `Array::opt` methods which can use new encode/decode options
-   - **Breaking** Existing `Array` `_opt` use new encode/decode options insted of `parallel: bool`
+ - **Breaking**: Added new `Array::opt` methods which can use `codec::CodecOptions` and existing methods use it instead of `parallel: bool`
  - Implement `DoubleEndedIterator` for `{Indices,LinearisedIndices,ContiguousIndices,ContiguousLinearisedIndicesIterator}Iterator`
  - Add `ParIndicesIterator` and `ParChunksIterator`
  - Implement `From<String>` for `DimensionName`

src/array/array_async_readable.rs

@@ -278,7 +278,7 @@ impl<TStorage: ?Sized + AsyncReadableStorageTraits + 'static> Array<TStorage> {
             .await
     }
 
-    /// Read and decode the chunk at `chunk_indices` into its bytes.
+    /// Read and decode the chunks at `chunks` into their bytes.
     ///
     /// # Errors
     /// Returns an [`ArrayError`] if
@@ -346,14 +346,14 @@ impl<TStorage: ?Sized + AsyncReadableStorageTraits + 'static> Array<TStorage> {
         }
     }
 
-    /// Read and decode the chunk at `chunk_indices` into its bytes (default options).
+    /// Read and decode the chunks at `chunks` into their bytes (default options).
     #[allow(clippy::missing_panics_doc, clippy::missing_errors_doc)]
     pub async fn async_retrieve_chunks(&self, chunks: &ArraySubset) -> Result<Vec<u8>, ArrayError> {
         self.async_retrieve_chunks_opt(chunks, &CodecOptions::default())
             .await
     }
 
-    /// Read and decode the chunk at `chunk_indices` into a vector of its elements.
+    /// Read and decode the chunks at `chunks` into a vector of their elements.
     ///
     /// # Errors
     /// Returns an [`ArrayError`] if the size of `T` does not match the data type size or a [`Array::async_retrieve_chunks`] error condition is met.
@@ -367,7 +367,7 @@ impl<TStorage: ?Sized + AsyncReadableStorageTraits + 'static> Array<TStorage> {
         Ok(transmute_from_bytes_vec::<T>(bytes))
     }
 
-    /// Read and decode the chunk at `chunk_indices` into a vector of its elements (default options).
+    /// Read and decode the chunks at `chunks` into a vector of their elements (default options).
     ///
     /// # Errors
     /// Returns an [`ArrayError`] if the size of `T` does not match the data type size or a [`Array::async_retrieve_chunks`] error condition is met.
@@ -380,7 +380,7 @@ impl<TStorage: ?Sized + AsyncReadableStorageTraits + 'static> Array<TStorage> {
     }
 
     #[cfg(feature = "ndarray")]
-    /// Read and decode the chunk at `chunk_indices` into an [`ndarray::ArrayD`].
+    /// Read and decode the chunks at `chunks` into an [`ndarray::ArrayD`].
     ///
     /// # Errors
     /// Returns an [`ArrayError`] if the size of `T` does not match the data type size or a [`Array::async_retrieve_chunks`] error condition is met.
@@ -398,7 +398,7 @@ impl<TStorage: ?Sized + AsyncReadableStorageTraits + 'static> Array<TStorage> {
     }
 
     #[cfg(feature = "ndarray")]
-    /// Read and decode the chunk at `chunk_indices` into an [`ndarray::ArrayD`] (default options).
+    /// Read and decode the chunks at `chunks` into an [`ndarray::ArrayD`] (default options).
     #[allow(clippy::missing_panics_doc, clippy::missing_errors_doc)]
     pub async fn async_retrieve_chunks_ndarray<T: bytemuck::Pod + Send + Sync>(
         &self,

src/array/array_sync_readable.rs

@@ -501,7 +501,7 @@ impl<TStorage: ?Sized + ReadableStorageTraits + 'static> Array<TStorage> {
         self.retrieve_chunks_opt(chunks, &CodecOptions::default())
     }
 
-    /// Read and decode the chunks at `chunks` into a vector of its elements.
+    /// Read and decode the chunks at `chunks` into a vector of their elements.
     ///
     /// # Errors
     /// Returns an [`ArrayError`] if any chunk indices in `chunks` are invalid or an error condition in [`Array::retrieve_chunks_opt`].
@@ -518,7 +518,7 @@ impl<TStorage: ?Sized + ReadableStorageTraits + 'static> Array<TStorage> {
         Ok(transmute_from_bytes_vec::<T>(bytes))
     }
 
-    /// Read and decode the chunks at `chunks` into a vector of its elements with default options
+    /// Read and decode the chunks at `chunks` into a vector of their elements (default options).
     ///
     /// # Errors
     /// See [`Array::retrieve_chunks_elements_opt`].

src/array/array_sync_readable_writable.rs

@@ -282,6 +282,7 @@ impl<TStorage: ?Sized + ReadableWritableStorageTraits + 'static> Array<TStorage>
                 unsafe { chunk_subset.contiguous_linearised_indices_unchecked(&chunk_shape) };
             let length =
                 usize::try_from(contiguous_iterator.contiguous_elements() * element_size).unwrap();
+            // FIXME: Par iter?
             for (chunk_element_index, _num_elements) in &contiguous_iterator {
                 let chunk_offset = usize::try_from(chunk_element_index * element_size).unwrap();
                 debug_assert!(chunk_offset + length <= chunk_bytes.len());