Skip to content

Commit

Permalink
DOC: tweaks to docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
GavinHuttley committed Oct 25, 2024
1 parent 9175df9 commit 60b810a
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions src/diverse_seq/cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -241,10 +241,7 @@ def make_cluster_tree(

@define_app(app_type=AppType.NON_COMPOSABLE)
class dvs_par_ctree(ClusterTreeBase):
"""Create a cluster tree from kmer distances.
If numprocs>1, computations are performed in parallel.
"""
"""Create a cluster tree from kmer distances in parallel."""

def __init__(
self,
Expand All @@ -262,8 +259,6 @@ def __init__(
Parameters
----------
seq_store
path to sequence store
k
kmer size
sketch_size
Expand All @@ -281,6 +276,9 @@ def __init__(
Notes
-----
This is app is not composable but can run in parallel. It is
best suited to a single large sequence collection.
If mash_canonical_kmers is enabled when using the mash distance,
kmers are considered identical to their reverse complement.
Expand Down

0 comments on commit 60b810a

Please sign in to comment.