Fix document layout and misspellings (#1127)

* fix document layout

* fix misspellings

Author: rhysd

autoload/lsp.vim

@@ -156,7 +156,7 @@ function! lsp#print_server_status() abort
 endfunction
 
 " @params {server_info} = {
-"   'name': 'go-langserver',        " requried, must be unique
+"   'name': 'go-langserver',        " required, must be unique
 "   'allowlist': ['go'],            " optional, array of filetypes to allow, * for all filetypes
 "   'blocklist': [],                " optional, array of filetypes to block, * for all filetypes,
 "   'cmd': {server_info->['go-langserver]} " function that takes server_info and returns array of cmd and args, return empty if you don't want to start the server

autoload/lsp/callbag.vim

@@ -1464,7 +1464,7 @@ endfunction
 "   \ 'env': {},
 "   \ })
 "   call s:Stdin(1, 'hi')
-"   call s:Stdin(2, lsp#callbag#undefined()) " requried to close stdin
+"   call s:Stdin(2, lsp#callbag#undefined()) " required to close stdin
 function! lsp#callbag#spawn(cmd, ...) abort
     let l:data = { 'cmd': a:cmd, 'opt': a:0 > 0 ? copy(a:000[0]) : {} }
     return lsp#callbag#create(function('s:spawnCreate', [l:data]))

autoload/lsp/internal/diagnostics/virtual_text.vim

@@ -49,7 +49,7 @@ function! lsp#internal#diagnostics#virtual_text#_enable() abort
     let s:enabled = 1
 
     if empty(s:namespace_id)
-        let s:namespace_id = nvim_create_namespace('vim_lsp_diagnotics_virtual_text')
+        let s:namespace_id = nvim_create_namespace('vim_lsp_diagnostic_virtual_text')
     endif
 
     let s:Dispose = lsp#callbag#pipe(

autoload/lsp/internal/document_range_formatting.vim

@@ -1,6 +1,6 @@
 " options - {
 "   bufnr: bufnr('%')       " required
-"   type: ''                " optional: defaults to visualmode(). overriden by opfunc
+"   type: ''                " optional: defaults to visualmode(). overridden by opfunc
 "   server - 'server_name'  " optional
 "   sync: 0                 " optional, defaults to 0 (async)
 " }

autoload/lsp/ui/vim/completion.vim

@@ -29,7 +29,7 @@ endfunction
 " 6. then the line is `call getbufline(|` in `s:on_complete_done_after`
 "
 function! s:on_complete_done() abort
-  " Somtimes, vim occurs `CompleteDone` unexpectedly.
+  " Sometimes, vim occurs `CompleteDone` unexpectedly.
   " We try to detect it by checking empty completed_item.
   if empty(v:completed_item) || get(v:completed_item, 'word', '') ==# '' && get(v:completed_item, 'abbr', '') ==# ''
     doautocmd <nomodeline> User lsp_complete_done

doc/vim-lsp.txt

@@ -451,8 +451,9 @@ g:lsp_diagnostics_echo_delay                *g:lsp_diagnostics_echo_delay*
     Type: |Number|
     Default: `500`
 
-    Delay milliseconds to echo diagnostic error for the current line to status. Requires
-    |g:lsp_diagnostics_enabled| and |g:lsp_diagnostics_echo_cursor| set to 1.
+    Delay milliseconds to echo diagnostic error for the current line to status.
+    Requires |g:lsp_diagnostics_enabled| and |g:lsp_diagnostics_echo_cursor| set
+    to 1.
 
     Example: >
 	let g:lsp_diagnostics_echo_delay = 200
@@ -462,8 +463,9 @@ g:lsp_diagnostics_float_cursor                *g:lsp_diagnostics_float_cursor*
     Type: |Number|
     Default: `0`
 
-    Enables a floating window of diagnostic error for the current line to status. Requires
-    nvim_win_open() or popup_create is available, and |g:lsp_diagnostics_enabled| set to 1.
+    Enables a floating window of diagnostic error for the current line to
+    status. Requires nvim_win_open() or popup_create is available, and
+    |g:lsp_diagnostics_enabled| set to 1.
 
     Example: >
 	let g:lsp_diagnostics_float_cursor = 1
@@ -515,7 +517,7 @@ g:lsp_diagnostics_highlights_enabled    *g:lsp_diagnostics_highlights_enabled*
 	highlight link LspErrorHighlight Error
 
 g:lsp_diagnostics_highlights_insert_mode_enabled
-			          *g:lsp_diagnostics_highlights_insert_mode_enabled*
+			     *g:lsp_diagnostics_highlights_insert_mode_enabled*
     Type: |Number|
     Default: `1`
 
@@ -526,7 +528,7 @@ g:lsp_diagnostics_highlights_insert_mode_enabled
 	let g:lsp_diagnostics_highlights_insert_mode_enabled = 1
 	let g:lsp_diagnostics_highlights_insert_mode_enabled = 0
 
-g:lsp_diagnostics_highlights_delay			*g:lsp_diagnostics_highlights_delay*
+g:lsp_diagnostics_highlights_delay	   *g:lsp_diagnostics_highlights_delay*
     Type: |Number|
     Default: `500`
 
@@ -883,7 +885,8 @@ g:lsp_snippet_expand                                 *g:lsp_snippet_expand*
     Type: |List|
 
     The integration point to other snippet plugin.
-    vim-lsp may invoke the first item of this value when it needs snippet expansion.
+    vim-lsp may invoke the first item of this value when it needs snippet
+    expansion.
 
 g:lsp_completion_resolve_timeout         *g:lsp_completion_resolve_timeout*
     Type: |Number|
@@ -1073,19 +1076,19 @@ The vim |dict| containing information about the server.
     For example: >
 	'config': { 'prefer_local': 1 }
 <
-	This can then be used by cmd function.
+    This can then be used by cmd function.
 >
-	    function! s:myserver_cmd(server_info) abort
-		let l:config = get(a:server_info, 'config', {})
-		let l:prefer_local = get(l:config, 'prefer_local', 1)
-		if (l:prefer_local)
-		    return ['./local-executable']
-		else
-		    return ['/bin/global-exectuable']
-		endif
-	    endfunction
-
-	    'cmd': function('s:myserver_cmd')
+	function! s:myserver_cmd(server_info) abort
+	    let l:config = get(a:server_info, 'config', {})
+	    let l:prefer_local = get(l:config, 'prefer_local', 1)
+	    if (l:prefer_local)
+	        return ['./local-executable']
+	    else
+	        return ['/bin/global-exectuable']
+	    endif
+	endfunction
+
+	'cmd': function('s:myserver_cmd')
 <
     Using the `config` key, you can also specify a custom 'typed word
     pattern', or a custom filter for completion items, see
@@ -1204,7 +1207,8 @@ You can use this function to add custom command handler.
   })
 <
 
-For example, the rust-analyzer expects the client handles some custom command as below example.
+For example, the rust-analyzer expects the client handles some custom command
+as below example.
 >
   function! s:rust_analyzer_apply_source_change(context)
       let l:command = get(a:context, 'command', {})
@@ -1227,17 +1231,16 @@ Stream api to listen to responses and notifications from language server or
 vim-lsp. Always verify the existence of request, response and server before
 accessing. Subscribing to stream should never throw an error.
 >
-function! s:on_textDocumentDiagnostics(x) abort
-    echom 'Diagnostics for ' . a:x['server'] . ' ' . json_encode(a:x['response'])
-endfunction
-
-au User lsp_setup call lsp#callbag#pipe(
-    \ lsp#stream(),
-    \ lsp#callbag#filter({x-> has_key(x, 'response') && !has_key(x['response'], 'error') && get(x['response'], 'method', '') == 'textDocument/publishDiagnostics'}),
-    \ lsp#callbag#subscribe({ 'next':{x->s:on_textDocumentDiagnostics(x)} }),
-    \ )
-<
+  function! s:on_textDocumentDiagnostics(x) abort
+      echom 'Diagnostics for ' . a:x['server'] . ' ' . json_encode(a:x['response'])
+  endfunction
 
+  au User lsp_setup call lsp#callbag#pipe(
+      \ lsp#stream(),
+      \ lsp#callbag#filter({x-> has_key(x, 'response') && !has_key(x['response'], 'error') && get(x['response'], 'method', '') == 'textDocument/publishDiagnostics'}),
+      \ lsp#callbag#subscribe({ 'next':{x->s:on_textDocumentDiagnostics(x)} }),
+      \ )
+<
 Custom vim-lsp notifications streams:
 vimp-lsp events mimic lsp server notifications.
 * `server` is always `$vimlsp`.
@@ -1271,7 +1274,6 @@ lsp#get_server_status({name-of-server})            *lsp#get_server_status()*
 
 Get the status of a server.
 
-
     Example: >
   call lsp#get_server_status('name-of-server')
 <
@@ -1326,7 +1328,7 @@ This method is mainly used to generate 'root_uri' when registering server.
 	* If there is not directory with the specific files or diretories
 	  found, the method will return an empty string.
 
-lsp#enable_diagnostics_for_buffer()          *lsp#enable_diagnotics_for_buffer()*
+lsp#enable_diagnostics_for_buffer()          *lsp#enable_diagnostic_for_buffer()*
 
 Re-enable diagnsostics for the specified buffer. By default diagnostics are
 enabled for all buffers.
@@ -1817,8 +1819,8 @@ https://github.com/thomasfaingnaert/vim-lsp-ultisnips
 https://github.com/Shougo/neosnippet.vim
 https://github.com/thomasfaingnaert/vim-lsp-neosnippet
 
-Refer to the readme and docs of vim-vsnip, vim-lsp-ultisnips and vim-lsp-neosnippet
-for more information and configuration options.
+Refer to the readme and docs of vim-vsnip, vim-lsp-ultisnips and
+vim-lsp-neosnippet for more information and configuration options.
 
 ==============================================================================
 Folding                                                    *vim-lsp-folding*
@@ -1850,7 +1852,7 @@ To display open and closed folds at the side of the window, see
 If you want to remove the dashes at the end of the folds, you can change
 the fold item of 'fillchars'.
 
-===============================================================================
+==============================================================================
 Semantic highlighting                                      *vim-lsp-semantic*
 
 To use semantic highlighting, you need Neovim highlights, or Vim with the
@@ -1929,7 +1931,7 @@ want function calls to still use the |Label| group, but use |Identifier| for
         \ }
         \ })
 <
-===============================================================================
+==============================================================================
 License                                                    *vim-lsp-license*
 
 The MIT License (MIT)