From: shane.xb.qian <shane.qian@foxmail.com>
Date: Mon, 26 Sep 2022 03:15:45 +0000 (+0800)
Subject: doc: correct doc about 'syncInit' and refine instr
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=1de2c0cf30d3725fbba6a003fa715898668878bb;p=vim-lsp.git
doc: correct doc about 'syncInit' and refine instr
---
diff --git a/doc/lsp.txt b/doc/lsp.txt
index 79d09e8..1511f0e 100644
--- a/doc/lsp.txt
+++ b/doc/lsp.txt
@@ -169,14 +169,14 @@ Shell script and Vim file types: >
\ filetype: ['go', 'gomod', 'gohtmltmpl', 'gotexttmpl'],
\ path: '/home/dza/.go/bin/gopls',
\ args: [],
- \ sync: v:true,
+ \ syncInit: v:true,
\ omnicompl: v:true,
\ },
\ #{
\ filetype: ['rust'],
\ path: '/home/dza/.cargo/bin/rust-analyzer',
\ args: [],
- \ sync: v:true,
+ \ syncInit: v:true,
\ omnicompl: v:true,
\ },
\ #{
@@ -201,15 +201,15 @@ To add a LSP server, the following information is needed:
any arguments).
args a list of command-line arguments passed to the LSP
server. Each argument is a separate List item.
- omnicompl a boolean value that enables (true) or disables
- (false) omni-completion for this file type.
+ omnicompl (Optional) a boolean value that enables (true)
+ or disables (false) omni-completion for this file
+ types. By default this is set to 'v:true'.
syncInit (Optional) for lsp servers (e.g. rust analyzer, gopls)
that take time to reply to a 'initialize' request
- message this should be set to 'v:true'. By default
- this is set to 'v:false'. If this is set to true,
- then a synchronous call is used to initialize the LSP
- server. Otherwise the server is initialized
- asynchronously.
+ message this should be set to 'v:true'. If this is set
+ to true, then a synchronous call is used to initialize
+ the LSP server, otherwise the server is initialized
+ asynchronously. By default this is set to 'v:false'.
The LSP servers are added using the LspAddServer() function. This function
accepts a list of LSP servers with the above information.