summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShougo Matsushita <Shougo.Matsu@gmail.com>2020-03-06 21:29:14 +0900
committerShougo Matsushita <Shougo.Matsu@gmail.com>2020-03-06 21:29:14 +0900
commit09aa6d3c42ea3abfa635744e109b4d8ebb951d8f (patch)
tree5a4b23fca6d82b3622103d68f5bced595a7d13dc
parent08582f7c52aa53d63f9a7a714fab9137d6ea48f0 (diff)
downloaddeoplete.nvim-09aa6d3c42ea3abfa635744e109b4d8ebb951d8f.zip
Update the documentation
-rw-r--r--doc/deoplete.txt123
1 files changed, 67 insertions, 56 deletions
diff --git a/doc/deoplete.txt b/doc/deoplete.txt
index b88c600..bfad429 100644
--- a/doc/deoplete.txt
+++ b/doc/deoplete.txt
@@ -1535,7 +1535,7 @@ A: 1. Please update neovim to the latest version.
2. Please update neovim python3 module to the latest version. >
- $ pip3 install --user pynvim --upgrade
+ $ pip3 install --user pynvim --upgrade
<
3. Please execute ":UpdateRemotePlugins" command manually if Neovim.
@@ -1546,7 +1546,7 @@ A: 1. Please update neovim to the latest version.
https://github.com/roxma/vim-hug-neovim-rpc
6. Please check if Python3 interface works. You can check it by the command
- `:echo has('python3')` .
+ `:echo has('python3')` .
https://github.com/neovim/neovim/wiki/FAQ#python-support-isnt-working
@@ -1554,11 +1554,11 @@ A: 1. Please update neovim to the latest version.
8. Please enable debug mode from command line and upload the log file. >
- $ export NVIM_PYTHON_LOG_FILE=/tmp/log
- $ export NVIM_PYTHON_LOG_LEVEL=DEBUG
- $ nvim
- ... Use deoplete
- $ cat /tmp/log_{PID}
+ $ export NVIM_PYTHON_LOG_FILE=/tmp/log
+ $ export NVIM_PYTHON_LOG_LEVEL=DEBUG
+ $ nvim
+ ... Use deoplete
+ $ cat /tmp/log_{PID}
Q: deoplete is slow.
@@ -1576,9 +1576,9 @@ A: If it is enabled, Neovim will enable and load deoplete in startup. It
may be slow. You should use lazy load feature in plugin manager or use
|:autocmd| to call |deoplete#enable()|. >
- " Enable deoplete when InsertEnter.
- let g:deoplete#enable_at_startup = 0
- autocmd InsertEnter * call deoplete#enable()
+ " Enable deoplete when InsertEnter.
+ let g:deoplete#enable_at_startup = 0
+ autocmd InsertEnter * call deoplete#enable()
<
And you should set |g:python3_host_prog| variable. It reduces startuptime
by almost 20 ms.
@@ -1587,26 +1587,26 @@ Q: deoplete cannot complete filename after "=".
A: 'isfname' contains "=". You should remove it. >
- set isfname-==
+ set isfname-==
Q: Deoplete does not work with vim-multiple-cursors.
A: You must disable deoplete when using vim-multiple-cursors. >
- function g:Multiple_cursors_before()
- call deoplete#custom#buffer_option('auto_complete', v:false)
- endfunction
- function g:Multiple_cursors_after()
- call deoplete#custom#buffer_option('auto_complete', v:true)
- endfunction
+ function g:Multiple_cursors_before()
+ call deoplete#custom#buffer_option('auto_complete', v:false)
+ endfunction
+ function g:Multiple_cursors_after()
+ call deoplete#custom#buffer_option('auto_complete', v:true)
+ endfunction
Q: I want to debug the sources.
A: Please enable logging feature like this. >
- call deoplete#custom#option('profile', v:true)
- call deoplete#enable_logging('DEBUG', 'deoplete.log')
- call deoplete#custom#source('jedi', 'is_debug_enabled', 1)
+ call deoplete#custom#option('profile', v:true)
+ call deoplete#enable_logging('DEBUG', 'deoplete.log')
+ call deoplete#custom#source('jedi', 'is_debug_enabled', 1)
Q: "Channel id must be a positive integer" error.
https://github.com/Shougo/deoplete.nvim/issues/406
@@ -1634,14 +1634,14 @@ https://github.com/neovim/pynvim/issues/326
Note: You can disable parallel feature by |deoplete-options-num_processes|.
It is workaround. >
- call deoplete#custom#option('num_processes', 1)
+ call deoplete#custom#option('num_processes', 1)
Q: "[deoplete] pynvim 0.3.0+ is required." error
https://github.com/Shougo/deoplete.nvim/issues/694
A: You must upgrade pynvim client. >
- $ pip3 install --user pynvim --upgrade
+ $ pip3 install --user pynvim --upgrade
Q: deoplete now automatically completes without permission
https://github.com/Shougo/deoplete.nvim/issues/1013
@@ -1659,15 +1659,15 @@ Q: I want to silence the |ins-completion-menu| messages in the command line
A: You can disable the messages through the 'shortmess' option. >
- if has("patch-7.4.314")
- set shortmess+=c
- endif
+ if has("patch-7.4.314")
+ set shortmess+=c
+ endif
Q: I want to use the auto select feature like |neocomplete|.
A: You can use it by the 'completeopt' option. >
- set completeopt+=noinsert
+ set completeopt+=noinsert
Q: How do I select one of the responses from the pop up? I assume this is
really obvious, but I have not figured it out.
@@ -1677,7 +1677,7 @@ A: Please press <C-y> on the candidate.
Q: I want to close the preview window after completion is done.
A: >
- autocmd CompleteDone * silent! pclose!
+ autocmd CompleteDone * silent! pclose!
<
Or
>
@@ -1691,7 +1691,7 @@ Q: I want to disable the preview window feature.
https://github.com/Shougo/deoplete.nvim/issues/298
A: >
- set completeopt-=preview
+ set completeopt-=preview
Q: I want to look selected function's arguments in deoplete. But I don't
like preview window feature.
@@ -1704,17 +1704,17 @@ Q: When I press enter, neovim closes the popup instead of inserting new line.
A: It is Vim/neovim's default behavior (feature.) If you want to insert the
new line, you should map <CR>. >
- inoremap <silent> <CR> <C-r>=<SID>my_cr_function()<CR>
- function! s:my_cr_function() abort
- return deoplete#close_popup() . "\<CR>"
- endfunction
+ inoremap <silent> <CR> <C-r>=<SID>my_cr_function()<CR>
+ function! s:my_cr_function() abort
+ return deoplete#close_popup() . "\<CR>"
+ endfunction
Q: I don't want to see the typed word in the completion menu.
A: You should add |deoplete-filter-matcher_length| to the matchers. >
- call deoplete#custom#source('_', 'matchers', ['matcher_fuzzy',
- \ 'matcher_length'])
+ call deoplete#custom#source('_', 'matchers', ['matcher_fuzzy',
+ \ 'matcher_length'])
<
Note: Replace `'_'` with a specific source such as `"around"` if you want to
keep seeing certain sources, e.g. snippets.
@@ -1724,37 +1724,37 @@ Q: How can I change the order of sources?
A: Change the rank of the sources as following, here illustrated for
UltiSnips >
- call deoplete#custom#source('ultisnips', 'rank', 1000)
+ call deoplete#custom#source('ultisnips', 'rank', 1000)
Q: How can I sort all entries alphabetically?
A: >
- call deoplete#custom#source('_', 'sorters', ['sorter_word'])
+ call deoplete#custom#source('_', 'sorters', ['sorter_word'])
Q: I want to use head matcher instead of fuzzy matcher.
A: You can achieve this by following >
- call deoplete#custom#source('_', 'matchers', ['matcher_head'])
+ call deoplete#custom#source('_', 'matchers', ['matcher_head'])
Q: I want to disable the buffer source.
A: You can use |deoplete-options-ignore_sources|. >
- call deoplete#custom#option('ignore_sources', {'_': ['buffer']})
+ call deoplete#custom#option('ignore_sources', {'_': ['buffer']})
Q: How to prevent auto bracket completion?
https://github.com/Shougo/deoplete.nvim/issues/150
A: >
- call deoplete#custom#source('_', 'converters',
- \ ['converter_remove_paren'])
+ call deoplete#custom#source('_', 'converters',
+ \ ['converter_remove_paren'])
Q: The candidates are filtered by first character.
https://github.com/Shougo/deoplete.nvim/issues/288
A: >
- call deoplete#custom#source('_', 'matchers', ['matcher_full_fuzzy'])
+ call deoplete#custom#source('_', 'matchers', ['matcher_full_fuzzy'])
Q: I want to use the syntax files as a completion source
@@ -1845,8 +1845,8 @@ Q: I want to disable the auto completion for certain filetypes.
A: Please use |deoplete-options-auto_complete|. >
- autocmd FileType tex
- \ call deoplete#custom#buffer_option('auto_complete', v:false)
+ autocmd FileType tex
+ \ call deoplete#custom#buffer_option('auto_complete', v:false)
Q: I want to use C/C++ omni completion with deoplete.
@@ -1863,26 +1863,26 @@ Q: I want to use JavaScript omnifunc.
A: Please set "input_patterns" manually. >
- call deoplete#custom#var('omni', 'input_patterns', {
- \ 'javascript': '[^. *\t]\.\w*',
- \ })
+ call deoplete#custom#var('omni', 'input_patterns', {
+ \ 'javascript': '[^. *\t]\.\w*',
+ \ })
Q: I want to use "vim-lua-ftplugin".
https://github.com/xolox/vim-lua-ftplugin
A: Please set the config as below. >
- let g:lua_check_syntax = 0
- let g:lua_complete_omni = 1
- let g:lua_complete_dynamic = 0
- let g:lua_define_completion_mappings = 0
+ let g:lua_check_syntax = 0
+ let g:lua_complete_omni = 1
+ let g:lua_complete_dynamic = 0
+ let g:lua_define_completion_mappings = 0
- call deoplete#custom#var('omni', 'functions', {
- \ 'lua': 'xolox#lua#omnifunc',
- \ })
- call deoplete#custom#var('omni', 'input_patterns', {
- \ 'lua': '\w+|\w+[.:]\w*',
- \ })
+ call deoplete#custom#var('omni', 'functions', {
+ \ 'lua': 'xolox#lua#omnifunc',
+ \ })
+ call deoplete#custom#var('omni', 'input_patterns', {
+ \ 'lua': '\w+|\w+[.:]\w*',
+ \ })
Q: I want to complete AAA using deoplete.
@@ -1901,6 +1901,17 @@ A: >
\ 'css': ['csscomplete#CompleteCSS']
\})
+Q: I want to use JavaScript omnifunc with context_filetype.vim.
+
+A: >
+
+ call deoplete#custom#var('omni', 'input_patterns', {
+ \ 'javascript': '[^. *\t]\.\w*',
+ \ })
+ call deoplete#custom#var('omni', 'functions', {
+ \ 'javascript': ['javascriptcomplete#CompleteJS']
+ \})
+<
*deoplete-faq-general*
4. General Questions~