docs: improve doc string accuracy

fulcrumgenomics · Jul 25, 2024 · c3aa60c · c3aa60c
1 parent ea80c6c
commit c3aa60c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/src/main/scala/com/fulcrumgenomics/umi/CollectDuplexSeqMetrics.scala b/src/main/scala/com/fulcrumgenomics/umi/CollectDuplexSeqMetrics.scala
@@ -315,8 +315,8 @@ class CollectDuplexSeqMetrics
       rec =>
         val exceptionString = s"Input BAM file to CollectDuplexSeqMetrics ($input) appears to contain consensus sequences. " +
           "CollectDuplexSeqMetrics cannot run on consensus BAMs, and instead requires the UMI-grouped BAM generated " +
-          "prior to consensus calling. The UMI-grouped BAM is the output of running GroupReadsByUmi." +
-          s"\nFirst record in $input has consensus SAM tags present:\n$rec"
+          "by GroupReadsByUmi which is run prior to consensus calling." +
+          "\nFirst record in $input has consensus SAM tags present:\n$rec"
 
         if (Umis.isFgbioStyleConsensus(rec)) throw new IllegalArgumentException(exceptionString)
     }

diff --git a/src/main/scala/com/fulcrumgenomics/umi/Umis.scala b/src/main/scala/com/fulcrumgenomics/umi/Umis.scala
@@ -129,9 +129,10 @@ object Umis {
     ch == 'A' || ch == 'C' || ch == 'G' || ch == 'T' || ch == 'N' || ch == '-'
   }
 
-  /** Tests if a record is a consensus or not
+  /** Returns True if the record appears to be a consensus read,
+   *  typically produced by fgbio's CallMolecularConsensusReads or CallDuplexConsensusReads.
    *
-   * @param rec the record to test
+   * @param rec the record to check
    * @return boolean indicating if the record is a consensus or not
    */
   def isFgbioStyleConsensus(rec: SamRecord): Boolean = {