mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-26 21:46:15 +00:00
docs: better formatting for Node API docs (#1892)
* Sets `"useCodeBlocks": true` * Adds a post-processing script `nodejs/typedoc_post_process.js` that puts the parameter description on the same line as the parameter name, like it is in our Python docs. This makes the text hierarchy clearer in those sections and also makes the sections shorter.
This commit is contained in:
@@ -10,7 +10,9 @@
|
||||
|
||||
### config?
|
||||
|
||||
> `optional` **config**: [`Index`](../classes/Index.md)
|
||||
```ts
|
||||
optional config: Index;
|
||||
```
|
||||
|
||||
Advanced index configuration
|
||||
|
||||
@@ -26,7 +28,9 @@ will be used to determine the most useful kind of index to create.
|
||||
|
||||
### replace?
|
||||
|
||||
> `optional` **replace**: `boolean`
|
||||
```ts
|
||||
optional replace: boolean;
|
||||
```
|
||||
|
||||
Whether to replace the existing index
|
||||
|
||||
|
||||
Reference in New Issue
Block a user