Skip to content

Commit e5634c0

Browse files
committed
Update the help file for the g:indent_guides_default_mapping option
1 parent 3cfeff1 commit e5634c0

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

doc/indent_guides.txt

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,15 @@ Default: ['help']. Values: list of strings.
170170
let g:indent_guides_exclude_filetypes = ['help', 'nerdtree']
171171
<
172172

173+
------------------------------------------------------------------------------
174+
*'indent_guides_default_mapping'*
175+
Use this option to control whether the default mapping (<Leader>ig) gets set.
176+
177+
Default: 1. Values: 0 or 1.
178+
>
179+
let g:indent_guides_default_mapping = 0
180+
<
181+
173182
==============================================================================
174183
4. MAPPINGS *indent-guides-mappings*
175184

@@ -179,14 +188,6 @@ map it to other keys. For example:
179188
:nmap <silent> <Leader>ig <Plug>IndentGuidesToggle
180189
<
181190

182-
The plugin will not provide the default mapping if either:
183-
* You already have something mapped to <Plug>IndentGuidesToggle.
184-
* You are already using the <Leader>ig key sequence.
185-
* You set to 0 the variable g:indent_guides_default_mapping:
186-
>
187-
let g:indent_guides_default_mapping=0
188-
<
189-
190191
You can also map some other commands that are not mapped by default. For
191192
example:
192193
>
@@ -257,6 +258,8 @@ Bug reports, feedback, suggestions etc are welcomed.
257258
1.8 (pending release)~
258259
* Added option g:|indent_guides_soft_pattern| to control the pattern for
259260
soft indentation (thanks @sergey-vlasov).
261+
* Added option g:|indent_guides_default_mapping| to control whether the
262+
default mapping (<Leader>ig) gets set (thanks @suy).
260263

261264
1.7~
262265
* Added way to override the default mapping (thanks xuhdev).

0 commit comments

Comments
 (0)