Skip to content

Commit 0e49edd

Browse files
committed
chore(bam): remove narrative comments
1 parent ed59a6c commit 0e49edd

2 files changed

Lines changed: 1 addition & 11 deletions

File tree

src/io/sam.rs

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -843,9 +843,6 @@ where
843843
builder = builder.add_read_group(id, map);
844844
}
845845

846-
// @PG line. Per SAM spec §1.3, populate PN/VN/CL alongside ID so downstream
847-
// provenance tools (MultiQC program-version table, etc.) see a fully
848-
// populated record matching STAR's @PG format.
849846
let mut pg = Map::<Program>::default();
850847
pg.other_fields_mut()
851848
.insert(program_tag::NAME, BString::from("rustar-aligner"));
@@ -1390,8 +1387,6 @@ mod tests {
13901387

13911388
#[test]
13921389
fn test_build_sam_header_pg_line_populated() {
1393-
// The @PG line must carry PN, VN and CL alongside ID per SAM spec §1.3,
1394-
// so downstream provenance tools (MultiQC etc.) get a non-blank entry.
13951390
let genome = make_test_genome();
13961391
let mut params = Parameters::parse_from(vec!["rustar-aligner", "--readFilesIn", "test.fq"]);
13971392
params.command_line =
@@ -1428,8 +1423,6 @@ mod tests {
14281423

14291424
#[test]
14301425
fn test_build_sam_header_pg_line_default_cl_when_unset() {
1431-
// When command_line is None (e.g. tests, library use), fall back to
1432-
// the program name so CL is still non-empty.
14331426
let genome = make_test_genome();
14341427
let params = Parameters::parse_from(vec!["rustar-aligner", "--readFilesIn", "test.fq"]);
14351428
assert!(params.command_line.is_none());

src/params.rs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -702,10 +702,7 @@ pub struct Parameters {
702702
#[arg(long = "chimOutType", num_args = 1..=2, default_values_t = vec!["Junctions".to_string()])]
703703
pub chim_out_type: Vec<String>,
704704

705-
/// Full command line as invoked (captured in `main` before clap parsing).
706-
/// Not a CLI argument; populated programmatically and embedded in the
707-
/// BAM `@PG` `CL:` field for provenance. STAR captures the same string
708-
/// in `P.commandLineFull`.
705+
/// Full command line as invoked, embedded in the BAM `@PG` `CL:` field.
709706
#[arg(skip)]
710707
pub command_line: Option<String>,
711708
}

0 commit comments

Comments
 (0)