Tweak phrasing of FugitiveConfig() family documentation

This commit is contained in:
Tim Pope
2021-07-26 07:06:32 -04:00
parent 07b8277475
commit 295780c507

View File

@@ -127,13 +127,17 @@ endfunction
" when performing multiple config queries. Do not rely on the internal " when performing multiple config queries. Do not rely on the internal
" structure of the return value as it is not guaranteed. If you want a full " structure of the return value as it is not guaranteed. If you want a full
" dictionary of every config value, use FugitiveConfigGetRegexp('.*'). " dictionary of every config value, use FugitiveConfigGetRegexp('.*').
"
" An optional argument provides the Git dir, or the buffer number of a
" buffer with a Git dir. The default is the current buffer. Pass a blank
" string to limit to the global config.
function! FugitiveConfig(...) abort function! FugitiveConfig(...) abort
return call('fugitive#Config', a:000) return call('fugitive#Config', a:000)
endfunction endfunction
" FugitiveConfigGet() retrieves a Git configuration value. An optional second " FugitiveConfigGet() retrieves a Git configuration value. An optional second
" argument provides the Git dir as with FugitiveFind(). Pass a blank string " argument can be either the object returned by FugitiveConfig(), or a Git
" to limit to the global config. " dir or buffer number to be passed along to FugitiveConfig().
function! FugitiveConfigGet(name, ...) abort function! FugitiveConfigGet(name, ...) abort
return get(call('FugitiveConfigGetAll', [a:name] + (a:0 ? [a:1] : [])), 0, get(a:, 2, '')) return get(call('FugitiveConfigGetAll', [a:name] + (a:0 ? [a:1] : [])), 0, get(a:, 2, ''))
endfunction endfunction