Skip to content

Commit c209f19

Browse files
dlechlukasbach
authored andcommitted
fix LiveDescriptors doc comment
Escape curly braces and fix spelling error. Fixes the following warnings: react-complex-tree/packages/core/src/types.ts:448:6 - warning Encountered an unescaped open brace without an inline tag 448 * of {variableName} can be used. react-complex-tree/packages/core/src/types.ts:448:19 - warning Unmatched closing brace 448 * of {variableName} can be used. react-complex-tree/packages/core/src/types.ts:450:7 - warning Encountered an unescaped open brace without an inline tag 450 * The {keybinding:bindingname} variable referns to a specific keybinding, i.e. {keybinding:primaryAction} react-complex-tree/packages/core/src/types.ts:450:30 - warning Unmatched closing brace 450 * The {keybinding:bindingname} variable referns to a specific keybinding, i.e. {keybinding:primaryAction} react-complex-tree/packages/core/src/types.ts:450:80 - warning Encountered an unescaped open brace without an inline tag 450 * The {keybinding:bindingname} variable referns to a specific keybinding, i.e. {keybinding:primaryAction} react-complex-tree/packages/core/src/types.ts:450:105 - warning Unmatched closing brace 450 * The {keybinding:bindingname} variable referns to a specific keybinding, i.e. {keybinding:primaryAction}
1 parent d0495c3 commit c209f19

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/core/src/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,9 +445,9 @@ export interface KeyboardBindings {
445445
* Live descriptors are written in an aria live region describing the state of the
446446
* tree to accessibility readers. They are displayed in a visually hidden area at the
447447
* bottom of the tree. Each descriptor composes a HTML string. Variables in the form
448-
* of {variableName} can be used.
448+
* of \{variableName\} can be used.
449449
*
450-
* The {keybinding:bindingname} variable referns to a specific keybinding, i.e. {keybinding:primaryAction}
450+
* The \{keybinding:bindingname\} variable refers to a specific keybinding, i.e. \{keybinding:primaryAction\}
451451
* is a valid variable.
452452
*
453453
* See the implementation of the `defaultLiveDescriptors` for more details.

0 commit comments

Comments
 (0)