name ksize parameter in constructor

oxli-bio · Sep 2, 2024 · 028e76c · 028e76c
1 parent af15fa4
commit 028e76c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/doc/api.md b/doc/api.md
@@ -13,7 +13,7 @@ Import necessary modules:
 Create a KmerCountTable with a k-mer size of 31:
 
 ```python
->>> counts = oxli.KmerCountTable(31)
+>>> counts = oxli.KmerCountTable(ksize=31)
 
 ```
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -19,6 +19,7 @@ struct KmerCountTable {
 #[pymethods]
 impl KmerCountTable {
     #[new]
+    #[pyo3(signature = (ksize))]
     pub fn new(ksize: u8) -> Self {
         Self {
             counts: HashMap::new(),