Skip to content

Commit e397e71

Browse files
devvaannshabose
authored andcommitted
fix: remove quotes and add code-blocks instead
1 parent dfd9d94 commit e397e71

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

src/editor/CodeHintManager.js

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@
6363
*
6464
* A code hint provider should implement the following three functions:
6565
*
66-
* - `CodeHintProvider.hasHints('editor', 'implicitChar')`
67-
* - `CodeHintProvider.getHints('implicitChar')`
68-
* - `CodeHintProvider.insertHint('hint')`
66+
* ```js
67+
* - `CodeHintProvider.hasHints(editor, implicitChar)`
68+
* - `CodeHintProvider.getHints(implicitChar)`
69+
* - `CodeHintProvider.insertHint(hint)`
70+
* ```
6971
*
7072
* The behavior of these three functions is described in detail below.
7173
*
72-
* __CodeHintProvider.hasHints('editor', 'implicitChar')__
74+
* ```js
75+
* __CodeHintProvider.hasHints(editor, implicitChar)__
76+
* ```
7377
*
7478
* The method by which a provider indicates intent to provide hints for a
7579
* given editor. The manager calls this method both when hints are
@@ -99,7 +103,9 @@
99103
* particular, it should keep a reference to the editor object so that it
100104
* can access the editor in future calls to getHints and insertHints.
101105
*
102-
* param {'Editor'} editor
106+
* ```js
107+
* param {Editor} editor
108+
* ```
103109
* A non-null editor object for the active window.
104110
*
105111
* param {String} implicitChar
@@ -113,7 +119,9 @@
113119
* whether it is appropriate to do so.
114120
*
115121
*
116-
* __CodeHintProvider.getHints('implicitChar')__
122+
* ```js
123+
* __CodeHintProvider.getHints(implicitChar)__
124+
* ```
117125
*
118126
* The method by which a provider provides hints for the editor context
119127
* associated with the current session. The getHints method is called only
@@ -198,8 +206,9 @@
198206
* of prefix matching, or can provide its own emphasis if it wishes to use
199207
* a more sophisticated matching algorithm.
200208
*
201-
*
202-
* __CodeHintProvider.insertHint('hint')__
209+
* ```js
210+
* __CodeHintProvider.insertHint(hint)__
211+
* ```
203212
*
204213
* The method by which a provider inserts a hint into the editor context
205214
* associated with the current session. The provider may assume that the

0 commit comments

Comments
 (0)