Clearer help for valid chunk key encoding separators

LDeakin · Jul 23, 2024 · b989794 · b989794
1 parent 4dc7473
commit b989794
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
  - `zarrs_reencode`: revise output and update docs
  - Update benchmarks and add plots
+ - Make the help clearer for valid chunk key encoding separators in various tools
 
 ## [0.5.2] - 2024-07-10
 

diff --git a/docs/zarrs_ome.md b/docs/zarrs_ome.md
@@ -103,7 +103,7 @@ Options:
             r*: "[0, 255]"
 
       --separator <SEPARATOR>
-          The chunk key encoding separator. Either `/`. or `.`
+          The chunk key encoding separator. Either . or /
 
   -c, --chunk-shape <CHUNK_SHAPE>
           Chunk shape. A comma separated list of the chunk size along each array dimension.

diff --git a/src/lib.rs b/src/lib.rs
@@ -42,7 +42,7 @@ pub struct ZarrEncodingArgs {
     #[arg(short, long, verbatim_doc_comment, allow_hyphen_values(true), value_parser = parse_fill_value)]
     pub fill_value: FillValueMetadata,
 
-    /// The chunk key encoding separator. Either `/`. or `.`.
+    /// The chunk key encoding separator. Either . or /.
     #[arg(long, default_value_t = '/')]
     pub separator: char,
 
@@ -266,7 +266,7 @@ pub struct ZarrReencodingArgs {
     #[arg(short, long, verbatim_doc_comment, allow_hyphen_values(true), value_parser = parse_fill_value)]
     pub fill_value: Option<FillValueMetadata>,
 
-    /// The chunk key encoding separator. Either `/`. or `.`.
+    /// The chunk key encoding separator. Either . or /.
     #[serde(skip_serializing_if = "Option::is_none")]
     #[arg(long)]
     pub separator: Option<char>,