Skip to content

Commit

Permalink
fix(docs): move the experimental partial encoding option
Browse files Browse the repository at this point in the history
Now correctly under the codec options heading
  • Loading branch information
LDeakin committed Jan 13, 2025
1 parent e44051d commit 682cdc0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions zarrs/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ use crate::array::{codec::CodecOptions, ArrayMetadataOptions};
/// This option sets the preferred minimum chunk concurrency.
/// The concurrency of internal codecs is adjusted to accomodate for the chunk concurrency in accordance with the concurrent target set in the [`CodecOptions`] parameter of an encode or decode method.
///
/// ### Experimental Partial Encoding
/// > default: [`false`]
///
/// If `true`, [`Array::store_chunk_subset`](crate::array::Array::store_chunk_subset) and [`Array::store_array_subset`](crate::array::Array::store_array_subset) and variants can use partial encoding.
/// This is relevant when using the sharding codec, as it enables inner chunks to be written without reading and writing entire shards.
///
/// This is an experimental feature for now until it has more comprehensively tested and support is added in the async API.
///
/// ## Metadata Options
///
/// ### Experimental Codec Store Metadata If Encode Only
Expand Down Expand Up @@ -96,14 +104,6 @@ use crate::array::{codec::CodecOptions, ArrayMetadataOptions};
///
/// Sets the names used when serialising and deserialising the names of experimental codecs.
/// Deserialisation also accepts the standard `IDENTIFIER` of the codec.
///
/// ### Experimental Partial Encoding
/// > default: [`false`]
///
/// If `true`, [`Array::store_chunk_subset`](crate::array::Array::store_chunk_subset) and [`Array::store_array_subset`](crate::array::Array::store_array_subset) and variants can use partial encoding.
/// This is relevant when using the sharding codec, as it enables inner chunks to be written without reading and writing entire shards.
///
/// This is an experimental feature for now until it has more comprehensively tested and support is added in the async API.
#[derive(Debug)]
#[allow(clippy::struct_excessive_bools)]
pub struct Config {
Expand Down

0 comments on commit 682cdc0

Please sign in to comment.