From 6892b25337bcf950fe646ca09c0312225072682c Mon Sep 17 00:00:00 2001 From: Tim Dunn Date: Tue, 16 Jul 2024 16:37:18 -0400 Subject: [PATCH] Improved `fqtk demux --help` output readability - added clap directive to print doc string verbatim - annotated code as bash to prevent `cargo doc` expecting rust code --- src/bin/commands/demux.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/bin/commands/demux.rs b/src/bin/commands/demux.rs index e2bec29..215071c 100644 --- a/src/bin/commands/demux.rs +++ b/src/bin/commands/demux.rs @@ -542,7 +542,7 @@ impl DemuxMetric { /// structures) of one of the types supplied to `--output-types`. FASTQ files have names /// of the format: /// -/// ``` +/// ```bash /// {sample_id}.{segment_type}{read_num}.fq.gz /// ``` /// @@ -559,7 +559,7 @@ impl DemuxMetric { /// reading a sample barcode, as well as an in-line 8bp sample barcode in read one, the command /// line would be: /// -/// ``` +/// ```bash /// fqtk demux \ /// --inputs r1.fq.gz i1.fq.gz i2.fq.gz r2.fq.gz \ /// --read-structures 8B92T 8B 8B 100T \ @@ -569,6 +569,7 @@ impl DemuxMetric { /// #[derive(Parser, Debug)] #[command(version)] +#[clap(verbatim_doc_comment)] pub(crate) struct Demux { /// One or more input fastq files each corresponding to a sequencing (e.g. R1, I1). #[clap(long, short = 'i', required = true, num_args = 1..)]