rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-07 20:32:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci(node): check docs in CI (#2084)

Browse Source 
* Make `npm run docs` fail if there are any warnings. This will catch
items missing from the API reference.
* Add a check in our CI to make sure `npm run dos` runs without warnings
and doesn't generate any new files (indicating it might be out-of-date.
* Hide constructors that aren't user facing.
* Remove unused enum `WriteMode`.

Closes #2068
This commit is contained in:
Will Jones
2025-01-30 16:06:06 -08:00
committed by GitHub
parent 25c17ebf4e
commit e05c0cd87e
59 changed files with 1287 additions and 597 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/js/classes/Index.md
View File

@@ -72,11 +72,9 @@ The results of a full text search are ordered by relevance measured by BM25.
You can combine filters with full text search.
For now, the full text search index only supports English, and doesn't support phrase search.
#### Parameters
* **options?**: `Partial`<`FtsOptions`>
* **options?**: `Partial`<[`FtsOptions`](../interfaces/FtsOptions.md)>
#### Returns
@@ -98,7 +96,7 @@ the vectors.
#### Parameters
* **options?**: `Partial`<`HnswPqOptions`>
* **options?**: `Partial`<[`HnswPqOptions`](../interfaces/HnswPqOptions.md)>
#### Returns
@@ -120,7 +118,7 @@ the vectors.
#### Parameters
* **options?**: `Partial`<`HnswSqOptions`>
* **options?**: `Partial`<[`HnswSqOptions`](../interfaces/HnswSqOptions.md)>
#### Returns