From daec72cea1b24bae9b245001ee03fb96433626c6 Mon Sep 17 00:00:00 2001 From: David Briscoe Date: Tue, 2 Apr 2019 21:52:30 -0700 Subject: [PATCH] Copy explanations into help doc. Explanations copied from #56. --- doc/matchup.txt | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/doc/matchup.txt b/doc/matchup.txt index 113ffd0..6c5af44 100644 --- a/doc/matchup.txt +++ b/doc/matchup.txt @@ -621,13 +621,24 @@ the function |timer_pause|, version 7.4.2180 and after. For neovim, this will only work in nvim-0.2.1 and after. *g:matchup_matchparen_deferred_show_delay* -*g:matchup_matchparen_deferred_hide_delay* - Adjust delays in milliseconds for deferred highlighting. + Delay, in milliseconds, between when the cursor moves and when we start + checking if the cursor is on a match. Applies to both making highlights and + clearing them for deferred highlighting. + Note: these delays cannot be changed dynamically and should be configured before the plugin loads (e.g., in your vimrc). - Defaults: 50, 700 + Defaults: 50 + +*g:matchup_matchparen_deferred_hide_delay* + + If the cursor has not stopped moving, assume highlight is stale after this + many milliseconds. Stale highlights are hidden. + + Note: this option cannot be changed dynamically. + + Defaults: 700 *g:matchup_matchparen_deferred_fade_time* *matchup-fading*