Skip to content

Commit dbf0b79

Browse files
committed
docs(simprint): clarify multi-type index parameter handling
Update SimprintIndexMulti protocol documentation to explain that multi-type indexes manage ndim per type (auto-detected) and extract realm_id from first entry rather than taking them as constructor parameters.
1 parent 4f20660 commit dbf0b79

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

iscc_search/protocols/simprint_multi.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,10 @@ class SimprintIndexMulti(Protocol):
7373
def __init__(self, uri, **kwargs):
7474
# type: (str, ...) -> None
7575
"""
76-
Open or create a simprint index at the specified location.
76+
Open or create a multi-type simprint index at the specified location.
77+
78+
Note: Multi-type indexes manage ndim per simprint type (auto-detected).
79+
realm_id is extracted from first entry and validated across all entries.
7780
7881
:param uri: Index location as URI:
7982
- File path: '/path/to/index' or 'file:///path/to/index'

0 commit comments

Comments
 (0)