From 9436e2357660be65500a230dbbbcc06ce147f0fd Mon Sep 17 00:00:00 2001 From: spike Date: Mon, 17 Oct 2022 02:20:17 +0200 Subject: [PATCH] update documentation + spacing --- README.md | 6 ++++++ doc/delaytrain.txt | 8 ++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9b05f04..9ff2aa9 100644 --- a/README.md +++ b/README.md @@ -119,9 +119,15 @@ default DelayTrain mappings are included below: ['nv'] = {'h', 'j', 'k', 'l'}, ['nvi'] = {'', '', '', ''}, }, + ignore_filestypes = {}, -- Example: set to {"help", "NvimTr*"} to + -- disable the plugin for help and NvimTree } ``` +You can define a list of filetypes that will be ignored by delaytrain using +`ignore_filestypes`. The option accepts a list of strings or patterns. +Tip: you can find the filetype for the current buffer using the command `:set ft?` + ### Mappings The keys option allows you to delay different keypresses in different modes. diff --git a/doc/delaytrain.txt b/doc/delaytrain.txt index e603cf2..a1466bb 100644 --- a/doc/delaytrain.txt +++ b/doc/delaytrain.txt @@ -45,8 +45,8 @@ following configuration (default settings included): ['nv'] = {'h', 'j', 'k', 'l'}, ['nvi'] = {'', '', '', ''}, }, - ignore_filestypes = {}, -- Example: set to {"help", "NvimTree"} to - -- disable the plugin for help and NvimTree + ignore_filestypes = {}, -- Example: set to {"help", "NvimTr*"} to + -- disable the plugin for help and NvimTree } < Keep in mind that the `delay_ms` timer starts on the FIRST keypress and not the @@ -63,6 +63,10 @@ the default settings, if you hit j and then hit k after 500ms, both keypresses will work. If you wait another 200ms and hit j again, the keypress will not work. +You can define a list of filetypes that will be ignored by delaytrain using +`ignore_filestypes`. The option accepts a list of strings or patterns. Tip: +you can find the filetype for the current buffer using the command `:set ft?` + ------------------------------------------------------------------------------ MAPPINGS *delaytrain-mappings*