VimPlug/fzf.vim
1
0
Fork 0
mirror of https://github.com/junegunn/fzf.vim.git synced 2025-12-07 05:04:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation and comments

Browse Source
This commit is contained in:
Junegunn Choi
2023-01-27 10:42:13 +09:00
parent ca542801a1
commit dc71692255
3 changed files with 60 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -81,8 +81,8 @@ Commands
| `:History:` | Command history |
| `:History/` | Search history |
| `:Snippets` | Snippets ([UltiSnips][us]) |
| `:Commits` | Git commits (requires [fugitive.vim][f]) |
| `:BCommits` | Git commits for the current buffer; visual-select lines to track changes in the range |
| `:Commits [LOG_OPTS]` | Git commits (requires [fugitive.vim][f]) |
| `:BCommits [LOG_OPTS]` | Git commits for the current buffer; visual-select lines to track changes in the range |
| `:Commands` | Commands |
| `:Maps` | Normal mode mappings |
| `:Helptags` | Help tags <sup id="a1">[1](#helptags)</sup> |

10
autoload/fzf/vim.vim
View File

@@ -143,7 +143,7 @@ function! s:prepend_opts(dict, eopts)
return s:extend_opts(a:dict, a:eopts, 1)
endfunction
" [[spec to wrap], [preview window expression], [toggle-preview keys...]]
" [spec to wrap], [preview window expression], [toggle-preview keys...]
function! fzf#vim#with_preview(...)
" Default spec
let spec = {}
@@ -827,7 +827,7 @@ function! s:ag_handler(lines, has_column)
call s:fill_quickfix(list)
endfunction
" query, [[ag options], options]
" query, [ag options], [spec (dict)], [fullscreen (bool)]
function! fzf#vim#ag(query, ...)
if type(a:query) != s:TYPE.string
return s:warn('Invalid query argument')
@@ -839,7 +839,7 @@ function! fzf#vim#ag(query, ...)
return call('fzf#vim#ag_raw', insert(args, command, 0))
endfunction
" ag command suffix, [options]
" ag command suffix, [spec (dict)], [fullscreen (bool)]
function! fzf#vim#ag_raw(command_suffix, ...)
if !executable('ag')
return s:warn('ag is not found')
@@ -847,7 +847,7 @@ function! fzf#vim#ag_raw(command_suffix, ...)
return call('fzf#vim#grep', extend(['ag --nogroup --column --color '.a:command_suffix, 1], a:000))
endfunction
" command (string), has_column (0/1), [options (dict)], [fullscreen (0/1)]
" command (string), has_column (bool), [spec (dict)], [fullscreen (bool)]
function! fzf#vim#grep(grep_command, has_column, ...)
let words = []
for word in split(a:grep_command)
@@ -918,7 +918,7 @@ function! s:btags_sink(lines)
normal! zvzz
endfunction
" query, [[tag commands], options]
" query, [tag commands], [spec (dict)], [fullscreen (bool)]
function! fzf#vim#buffer_tags(query, ...)
let args = copy(a:000)
let escaped = fzf#shellescape(expand('%'))

12
doc/fzf-vim.txt
View File

@@ -1,4 +1,4 @@
fzf-vim.txt fzf-vim Last change: January 15 2023
fzf-vim.txt fzf-vim Last change: January 27 2023
FZF-VIM - TABLE OF CONTENTS *fzf-vim* *fzf-vim-toc*
==============================================================================
@@ -112,9 +112,9 @@ COMMANDS *fzf-vim-commands*
*:Windows* *:Locate* *:History* *:Snippets* *:Commits* *:BCommits* *:Commands* *:Maps*
*:Helptags* *:Filetypes*
------------------+--------------------------------------------------------------------------------------
-----------------------+--------------------------------------------------------------------------------------
Command | List ~
------------------+--------------------------------------------------------------------------------------
-----------------------+--------------------------------------------------------------------------------------
`:Files [PATH]` | Files (runs `$FZF_DEFAULT_COMMAND` if defined)
`:GFiles [OPTS]` | Git files ( `git ls-files` )
`:GFiles?` | Git files ( `git status` )
@@ -133,13 +133,13 @@ COMMANDS *fzf-vim-commands*
`:History:` | Command history
`:History/` | Search history
`:Snippets` | Snippets ({UltiSnips}{9})
`:Commits` | Git commits (requires {fugitive.vim}{10})
`:BCommits` | Git commits for the current buffer; visual-select lines to track changes in the range
`:Commits [LOG_OPTS]` | Git commits (requires {fugitive.vim}{10})
`:BCommits [LOG_OPTS]` | Git commits for the current buffer; visual-select lines to track changes in the range
`:Commands` | Commands
`:Maps` | Normal mode mappings
`:Helptags` | Help tags [1]
`:Filetypes` | File types
------------------+--------------------------------------------------------------------------------------
-----------------------+--------------------------------------------------------------------------------------
*g:fzf_command_prefix*