Skip to content

Commit 010dfdc

Browse files
committed
docs: update markdown files, after build fail issue fix
1 parent 40a140f commit 010dfdc

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

docs/API-Reference/JSUtils/ScopeManager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Marks the file as being dirty.
200200

201201
| Param | Type | Description |
202202
| --- | --- | --- |
203-
| changeList | <code>Object</code> | {from: {line:number, ch: number}, to: {line:number, ch:number}} |
203+
| changeList | <code>Object</code> | An object representing the change range with `from` and `to` properties, each containing `line` and `ch` numbers. |
204204

205205
<a name="handleEditorChange"></a>
206206

docs/API-Reference/command/KeyBindingManager.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,10 @@ Remove a key binding from _keymap
6868

6969
<a name="getKeymap"></a>
7070

71-
## getKeymap([defaults]) ⇒ <code>Object.&lt;string, {commandID: string, key: string, displayKey: string}&gt;</code>
71+
## getKeymap([defaults]) ⇒ <code>Object</code>
7272
Returns a copy of the current key map. If the optional 'defaults' parameter is true,
7373
then a copy of the default key map is returned.
74+
In the default keymap each key is associated with an object containing `commandID`, `key`, and `displayKey`.
7475

7576
**Kind**: global function
7677

docs/API-Reference/widgets/Dialogs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The template can either be a string or a jQuery object representing a DOM node t
7272

7373
<a name="showModalDialog"></a>
7474

75-
## showModalDialog(dlgClass, [title], [message], [buttons], [autoDismiss]) ⇒ [<code>Dialog</code>](#new_Dialog_new)
75+
## showModalDialog(dlgClass, [title], [message], buttons, [autoDismiss]) ⇒ [<code>Dialog</code>](#new_Dialog_new)
7676
Creates a new general purpose modal dialog using the default template and the template variables given
7777
as parameters as described.
7878

@@ -83,7 +83,7 @@ as parameters as described.
8383
| dlgClass | <code>string</code> | A class name identifier for the dialog. Typically one of DefaultDialogs.* |
8484
| [title] | <code>string</code> | The title of the dialog. Can contain HTML markup. Defaults to "". |
8585
| [message] | <code>string</code> | The message to display in the dialog. Can contain HTML markup. Defaults to "". |
86-
| [buttons] | <code>Array.&lt;{className: string, id: string, text: string, tooltip:string}&gt;</code> | An array of buttons where each button has a class, id tooltip, and text property. The id is used in "data-button-id". Defaults to a single Ok button. Typically className is one of DIALOG_BTN_CLASS_*, id is one of DIALOG_BTN_* |
86+
| buttons | <code>Array.&lt;Object&gt;</code> | An array of buttons where each button has a class, id tooltip, and text property. The id is used in "data-button-id". Defaults to a single Ok button. Typically className is one of DIALOG_BTN_CLASS_*, id is one of DIALOG_BTN_* |
8787
| [autoDismiss] | <code>boolean</code> | Whether to automatically dismiss the dialog when one of the buttons is clicked. Default true. If false, you'll need to manually handle button clicks and the Esc key, and dismiss the dialog yourself when ready by calling `close()` on the returned dialog. |
8888

8989
<a name="showConfirmDialog"></a>

0 commit comments

Comments
 (0)