Fix type annotation and docstring

jlumpe · Aug 4, 2024 · f055cf3 · f055cf3
1 parent 137dcb9
commit f055cf3
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/gambit/kmers.py b/src/gambit/kmers.py
@@ -129,7 +129,7 @@ def __from_json__(cls, data: dict[str, Any]) -> 'KmerSpec':
 
 @attrs(slots=True)
 class KmerMatch:
-	"""Represents a
+	"""Represents the location of a k-mer prefix found within a DNA sequence.
 
 	Attributes
 	----------

diff --git a/src/gambit/metric.py b/src/gambit/metric.py
@@ -54,7 +54,7 @@ def jaccard_bits(bits1: np.ndarray, bits2: np.ndarray) -> float:
 	return 1. if union == 0 else intersection / union
 
 
-def jaccarddist_array(query: KmerSignature, refs: Sequence[KmerSignature], out: np.ndarray = None) -> np.ndarray:
+def jaccarddist_array(query: KmerSignature, refs: Sequence[KmerSignature], out: Optional[np.ndarray] = None) -> np.ndarray:
 	"""
 	Calculate Jaccard distances between a query k-mer signature and a list of reference signatures.