Skip to content

Commit

Permalink
update comments/docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ctb committed Mar 28, 2022
1 parent da093e3 commit 26e919b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/sourmash/index/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@
MultiIndex - in-memory storage and selection of signatures from multiple
index objects, using manifests. All signatures are kept in memory.
LazyLoadedIndex - selection on manifests with loading of index on demand.
StandaloneManifestIndex - load manifests directly, and do lazy loading of
signatures on demand. No signatures are kept in memory.
LazyLoadedIndex - selection on manifests with loading of index on demand.
(Consider using StandaloneManifestIndex instead.)
CounterGather - an ancillary class returned by the 'counter_gather()' method.
"""

Expand Down Expand Up @@ -1063,6 +1064,8 @@ class LazyLoadedIndex(Index):
from disk every time they are needed (e.g. 'find(...)', 'signatures()').
Wrapper class; signatures dynamically loaded from disk; uses manifests.
CTB: This may be redundant with StandaloneManifestIndex.
"""
def __init__(self, filename, manifest):
"Create an Index with given filename and manifest."
Expand Down Expand Up @@ -1160,7 +1163,7 @@ def select(self, **kwargs):
class StandaloneManifestIndex(Index):
"""Load a standalone manifest as an Index.
This class is useful for the situtation where you have a directory
This class is useful for the situation where you have a directory
with many signature collections underneath it, and you don't want to load
every collection each time you run sourmash.
Expand Down

0 comments on commit 26e919b

Please sign in to comment.