Skip to content

Commit 26fdb8a

Browse files
committed
update docs
1 parent 9c17c78 commit 26fdb8a

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

ocaml-lsp-server/docs/ocamllsp/typeSearch-spec.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,26 +30,22 @@ export interface TypeSearchParams extends TexDocumentPositionParams
3030
- `with_doc`: If to return documentation information or not
3131

3232
## Response
33-
34-
```js
35-
result: TypeSearch | null
36-
export interface TypeSearch {
37-
type t = Query_protocol.type_search_result list
33+
```json
34+
{
35+
[
36+
"name": string,
37+
"typ": string,
38+
"loc": Range,
39+
"doc": string,
40+
"cost": int,
41+
"constructible" : string
42+
]
3843
}
39-
```
40-
- `t`: A list of types that match the query.
41-
```
42-
type Query_protocol.type_search_result =
43-
{
44-
"name": string; // The fully qualified name of this result.,
45-
"typ": string; // The signature of this result,
46-
"loc": { // The location of the definition of this result in the source code.
47-
"end": { "character": int, "line": int },
48-
"start": { "character": int, "line": int }
49-
},
50-
"doc": string // Optional documentation associated with this result.,
51-
"cost": int; // A numeric value representing the "cost" or distance between this result and the query.
52-
constructible : string; // A constructible form or template that can be used to invoke this result
53-
}
54-
```
44+
```
45+
- name: The fully qualified name of this result.,
46+
- typ: The signature of this result,
47+
- loc: The location of the definition of this result in the source code.,
48+
- doc: Optional documentation associated with this result.,
49+
- cost: A numeric value representing the "cost" or distance between this result and the query.
50+
- constructible: A constructible form or template that can be used to invoke this result
5551
- A response with null result is returned if no entries are found.

0 commit comments

Comments
 (0)