diff options
| author | Hirokazu Hata <h.hata.ai.t@gmail.com> | 2020-06-27 11:27:51 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-27 11:27:51 +0900 |
| commit | 7efb302d26abd863e2cbbf4d2d6f7bb4aa31cc29 (patch) | |
| tree | 249ccd0759e4d61bdaea99f27e4e1c4ae965bbdc /runtime/doc | |
| parent | 225f0bcd98dd8ff8cab964f13816dfdf327038ae (diff) | |
| parent | ebee9ebe2be2bd584efefc4064a8b3a07e0505e0 (diff) | |
| download | rneovim-7efb302d26abd863e2cbbf4d2d6f7bb4aa31cc29.tar.gz rneovim-7efb302d26abd863e2cbbf4d2d6f7bb4aa31cc29.tar.bz2 rneovim-7efb302d26abd863e2cbbf4d2d6f7bb4aa31cc29.zip | |
Merge pull request #12252 from dlukes/formatting-sync
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/lsp.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index f81265c2c8..c3d25586b6 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -58,6 +58,11 @@ Nvim provides the |vim.lsp.omnifunc| 'omnifunc' handler which allows " Use LSP omni-completion in Python files. autocmd Filetype python setlocal omnifunc=v:lua.vim.lsp.omnifunc +If a function has a `*_sync` variant, it's primarily intended for being run +automatically on file save. E.g. code formatting: > + + " Auto-format *.rs files prior to saving them + autocmd BufWritePre *.rs lua vim.lsp.buf.formatting_sync(nil, 1000) ================================================================================ FAQ *lsp-faq* @@ -767,6 +772,12 @@ document_symbol() *vim.lsp.buf.document_symbol()* formatting({options}) *vim.lsp.buf.formatting()* TODO: Documentation +formatting_sync({options}, {timeout_ms}) *vim.lsp.buf.formatting_sync()* + Same as |vim.lsp.buf.formatting()| but synchronous. Useful + for running on save, to make sure buffer is formatted prior + to being saved. {timeout_ms} is passed on to + |vim.lsp.buf_request_sync()|. + hover() *vim.lsp.buf.hover()* TODO: Documentation |