Fixup docs

BioJulia · Jun 7, 2022 · f8ea398 · f8ea398 · TransGirlCodes · Jun 8, 2022
1 parent 014b503
commit f8ea398
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/src/kmer_iteration/EveryCanonicalKmer.jl b/src/kmer_iteration/EveryCanonicalKmer.jl
@@ -1,5 +1,6 @@
 """
-An iterator over every canonical valid overlapping `T<:Kmer` in a given longer `BioSequence`.
+An iterator over every canonical valid overlapping `T<:Kmer` in a given longer 
+`BioSequence`, between a `start` and `stop` position.
 
 !!! note
     Typically, the alphabet of the Kmer type matches the alphabet of the input

diff --git a/src/kmer_iteration/EveryKmer.jl b/src/kmer_iteration/EveryKmer.jl
@@ -8,7 +8,7 @@
 
 """
 An iterator over every valid overlapping `T<:Kmer` in a given longer
-`BioSequence` between `start` and `stop`.
+`BioSequence` between a `start` and `stop` position. 
 
 !!! note
     Typically, the alphabet of the Kmer type matches the alphabet of the input

diff --git a/src/kmer_iteration/SpacedCanonicalKmers.jl b/src/kmer_iteration/SpacedCanonicalKmers.jl
@@ -1,7 +1,7 @@
 
 """
 An iterator over every valid `T<:Kmer` separated by a `step` parameter, in a given
-longer `BioSequence`.
+longer `BioSequence`, between a `start` and `stop` position.
 
 !!! note
     Typically, the alphabet of the Kmer type matches the alphabet of the input

diff --git a/src/kmer_iteration/SpacedKmers.jl b/src/kmer_iteration/SpacedKmers.jl
@@ -1,7 +1,7 @@
 
 """
 An iterator over every valid `T<:Kmer` separated by a `step` parameter, in a given
-longer `BioSequence`.
+longer `BioSequence`, between a `start` and `stop` position.
 
 !!! note
     Typically, the alphabet of the Kmer type matches the alphabet of the input