Skip to content

Commit af9e42a

Browse files
authored
Updated docs with describe_collection method
1 parent cbf73f1 commit af9e42a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/src/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,9 @@ res = search(Dice(), db, "foo"; α=0.8, ranked=true)
7070
# ("foo", 1.0)
7171
# ("fooo", 0.8888888888888888)
7272

73-
73+
# Describe a working database collection
74+
desc = describe_collection(db)
75+
# (total_collection = 3, avg_num_ngrams = 4.5, total_ngrams = 13)
7476
```
7577

7678
## TODO: Benchmarks

0 commit comments

Comments
 (0)