Skip to content
This repository was archived by the owner on Apr 24, 2022. It is now read-only.

Commit 0352539

Browse files
committed
Misc README fixes
1 parent d42bd92 commit 0352539

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ Use the built-in package manager or one of the various package managers.
5151
| `modeCommands` | 1 | A dictionary of commands→strings to execute. |
5252
| `commandList` | 2 | A list of the commands in a `modeCallback`. |
5353

54-
- Note that either `modeCallback` OR `modeCommands` may be specified, not both.
54+
- Note that _either_ `modeCallback` _or_ `modeCommands` may be specified, __not both__.
5555
- Note that `commandList` is an optional parameter.
5656
- It is used as a completion source for when `modeCallback` is specified.
57-
- Additionally, `commandList` is IGNORED when `modeCommands` is specified since completions can be created from the dictionary keys.
57+
- Additionally, `commandList` is __ignored__ when `modeCommands` is specified since completions can be created from the dictionary keys.
5858
- If `commandList` is not specified when `modeCallback` is, no completions will be provided for the prompt.
5959

6060
## Receiving Input
@@ -90,15 +90,15 @@ command! FooModeEnter call libmodal#Enter('FOO', funcref('s:FooMode'))
9090
nnoremap <expr> <leader>n FooModeEnter
9191
```
9292

93-
- Note the `funcref()` call. It must be there or else `libmodal#Enter` won't execute properly.
93+
- Note the `funcref()` call. __It must be there__ or else `libmodal#Enter` won't execute properly.
9494

9595
### Key Combinations
9696

9797
While normally `libmodal` dictates that a user should define their own function for controlling a mode, there is a way to specify key combinations. If the second argument is set to a `modeCombos` dictionary, `libmodal#Enter` will automatically detect the caller's intent and pass control over to an auxilliary function built to handle pre-defined combos.
9898

9999
When providing `modeCombos`, it is important to note that one no longer has to receive input for themselves. Despite this, the unique variable (see `libmodal-receiving-input`) is still updated, and you can create a listener for it just like for any other variable.
100100

101-
- Note that |libmodal-exit-supression| is still compatable with defining key combinations.
101+
- Note that `libmodal-exit-supression` is still compatable with defining key combinations.
102102

103103
Here is an example that shows how to create a dictionary that defines the following actions:
104104

@@ -126,8 +126,8 @@ call libmodal#Enter('BAR', s:barModeCombos)
126126

127127
This allows `libmodal` to quickly determine which mappings are and are not part of the mode. Because of this method, modes with mappings that have similar beginnings are more efficient, and modes with more mappings get more benefit from the quick tree-like traversal.
128128

129-
- Note that |libmodal#Enter| will only parse a `modeCombos` dict once upon entrance.
130-
- Changes to the mapping dictionary that may occur while in a mode are not reflected until the mode is entered again and the dictionary is re-parsed.
129+
- Note that `libmodal#Enter` will only parse a `modeCombos` dict _once_ upon entrance.
130+
- Changes to the mapping dictionary that may occur while in a mode _are not reflected_ until the mode is entered again and the dictionary is re-parsed.
131131

132132
### Exit Supression
133133

@@ -180,7 +180,7 @@ call libmodal#Prompt('BAR', s:barModeCommands)
180180
call libmodal#Prompt('BAR', funcref('s:BarMode'), s:barModeCommandList)
181181
```
182182

183-
- Note that if you want to create commands with arguments, you will need to use a callback.
183+
- Note that if you want to create commands with arguments, _you will need to use a callback_.
184184

185185
# Submodes
186186

0 commit comments

Comments
 (0)