Skip to content

Commit 92d9c92

Browse files
devvaannshabose
authored andcommitted
docs: update api docs after fix
1 parent e397e71 commit 92d9c92

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

docs/API-Reference/editor/CodeHintManager.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,17 @@ __CodeHintProvider Overview:__
4747

4848
A code hint provider should implement the following three functions:
4949

50-
- `CodeHintProvider.hasHints('editor', 'implicitChar')`
51-
- `CodeHintProvider.getHints('implicitChar')`
52-
- `CodeHintProvider.insertHint('hint')`
50+
```js
51+
- `CodeHintProvider.hasHints(editor, implicitChar)`
52+
- `CodeHintProvider.getHints(implicitChar)`
53+
- `CodeHintProvider.insertHint(hint)`
54+
```
5355

5456
The behavior of these three functions is described in detail below.
5557

56-
__CodeHintProvider.hasHints('editor', 'implicitChar')__
58+
```js
59+
__CodeHintProvider.hasHints(editor, implicitChar)__
60+
```
5761

5862
The method by which a provider indicates intent to provide hints for a
5963
given editor. The manager calls this method both when hints are
@@ -83,7 +87,9 @@ may wish to prepare to cache data suitable for the current session. In
8387
particular, it should keep a reference to the editor object so that it
8488
can access the editor in future calls to getHints and insertHints.
8589

86-
param {'Editor'} editor
90+
```js
91+
param {Editor} editor
92+
```
8793
A non-null editor object for the active window.
8894

8995
param {String} implicitChar
@@ -97,7 +103,9 @@ the given editor context and, in case implicitChar is non- null,
97103
whether it is appropriate to do so.
98104

99105

100-
__CodeHintProvider.getHints('implicitChar')__
106+
```js
107+
__CodeHintProvider.getHints(implicitChar)__
108+
```
101109

102110
The method by which a provider provides hints for the editor context
103111
associated with the current session. The getHints method is called only
@@ -182,8 +190,9 @@ choose to let the manager handle emphasis for the simple and common case
182190
of prefix matching, or can provide its own emphasis if it wishes to use
183191
a more sophisticated matching algorithm.
184192

185-
186-
__CodeHintProvider.insertHint('hint')__
193+
```js
194+
__CodeHintProvider.insertHint(hint)__
195+
```
187196

188197
The method by which a provider inserts a hint into the editor context
189198
associated with the current session. The provider may assume that the

0 commit comments

Comments
 (0)