Merge pull request #1310 from glacambre/mention_disable

excmds.ts: use word "disable" in mode/blacklistadd doc
This commit is contained in:
Oliver Blanthorn 2019-02-03 10:48:49 +00:00 committed by GitHub
commit 69a1c1a88d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2403,11 +2403,18 @@ export function version() {
fillcmdline_notrail(TRI_VERSION)
}
/** Example:
- `mode ignore` to ignore all keys.
Note that when in ignore mode, Tridactyl will not switch to insert mode when focusing text areas/inputs. This is by design.
*/
/**
* Switch mode.
*
* For now you probably shouldn't manually switch to other modes than `normal` and `ignore`. Make sure you're aware of the key bindings (ignoremaps) that will allow you to go come back to normal mode from ignore mode before you run `:mode ignore` otherwise you're going to have a hard time re-enabling Tridactyl.
*
* Example:
* - `mode ignore` to ignore almost all keys.
*
* If you're looking for a way to temporarily disable Tridactyl, `mode ignore` might be what you're looking for.
*
* Note that when in ignore mode, Tridactyl will not switch to insert mode when focusing text areas/inputs. This is by design.
*/
//#content
export function mode(mode: ModeName) {
// TODO: event emition on mode change.
@ -3134,6 +3141,8 @@ export function autocmddelete(event: string, url: string) {
*
* Due to a Tridactyl bug, the only way to remove these rules once they are set is to delete all of your autocmds with `unset autocmds`.
*
* If you're looking for a way to temporarily disable Tridactyl, this might be what you're looking for.
*
* <!-- this should probably be moved to an ex alias once configuration has better help --!>
*
*/