From c08b5604868a3ba4dc20c99be27e4e1e9dd26c27 Mon Sep 17 00:00:00 2001 From: Clint Valentine Date: Thu, 13 Jan 2022 10:45:39 -0500 Subject: [PATCH] chore: fixup typos and reference in scaladoc --- .../scala/com/fulcrumgenomics/bam/api/SamSource.scala | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/scala/com/fulcrumgenomics/bam/api/SamSource.scala b/src/main/scala/com/fulcrumgenomics/bam/api/SamSource.scala index d997d07c3..22f71a2ed 100644 --- a/src/main/scala/com/fulcrumgenomics/bam/api/SamSource.scala +++ b/src/main/scala/com/fulcrumgenomics/bam/api/SamSource.scala @@ -42,10 +42,10 @@ object SamSource { * * @param path the path to read the SAM/BAM/CRAM from * @param index an optional path to read the index from - * @param ref an optional reference sequencing for decoding CRAM files + * @param ref an optional reference sequence for decoding CRAM files * @param async if true use extra thread(s) to speed up reading * @param stringency the validation stringency to apply when reading the data - * @param factory a SAMRecordFactory; MUST return classes that mix in [[SamRecord]] + * @param factory a [[SAMRecordFactory]]; MUST return classes that mix in [[SamRecord]] */ def apply(path: PathToBam, index: Option[FilePath] = None, @@ -69,10 +69,10 @@ object SamSource { /** Constructs a [[SamSource]] to read from the provided input stream. * * @param stream the input stream of SAM/BAM/CRAM bytes - * @param ref an optional reference sequencing for decoding CRAM files + * @param ref an optional reference sequence for decoding CRAM files * @param async if true use extra thread(s) to speed up reading * @param stringency the validation stringency to apply when reading the data - * @param factory a SAMRecordFactory; MUST return classes that mix in [[SamRecord]] + * @param factory a [[SAMRecordFactory]]; MUST return classes that mix in [[SamRecord]] */ def apply( stream: InputStream,