Skip to content

Commit

Permalink
Improved fqtk demux --help output readability
Browse files Browse the repository at this point in the history
 - added clap directive to print doc string verbatim
 - annotated code as bash to prevent `cargo doc` expecting rust code
  • Loading branch information
TimD1 committed Jul 16, 2024
1 parent 6ed98a3 commit 6892b25
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/bin/commands/demux.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
/// ```
///
Expand All @@ -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 \
Expand All @@ -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..)]
Expand Down

0 comments on commit 6892b25

Please sign in to comment.