Add more descriptions in detail for CRAM reader option

chrovis · Mar 21, 2024 · db30ca3 · db30ca3
1 parent 61237ad
commit db30ca3
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/cljam/io/cram.clj b/src/cljam/io/cram.clj
@@ -13,7 +13,10 @@
 
   The function also takes an optional argument `option`, which is a map that
   consists of:
-    - reference: a string representing the path to a reference file"
+    - reference: A string representing the path to the reference file, or
+                 a sequence reader that reads sequences from the reference file.
+                 This may be omitted only when the CRAM file to be read does not
+                 require a reference file."
   (^CRAMReader [f] (reader f {}))
   (^CRAMReader [f option]
    (if (io-util/cram-reader? f)