mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-22 17:11:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(lsp): correct usage examples of formatexpr (#16216)

Browse Source
This commit is contained in:
Michael Lingelbach
2021-11-02 17:02:04 -07:00
committed by GitHub
parent 487286b621
commit 7899c4099b
2 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
runtime/doc/lsp.txt
View File

@@ -63,7 +63,7 @@ Example config (in init.vim): >
-- Use LSP as the handler for formatexpr. -- Use LSP as the handler for formatexpr.
-- See `:help formatexpr` for more information. -- See `:help formatexpr` for more information.
vim.api.nvim_buf_set_option(0, 'formatexpr', 'v:lua.vim.lsp.formatexpr') vim.api.nvim_buf_set_option(0, 'formatexpr', 'v:lua.vim.lsp.formatexpr()')
-- For plugins with an `on_attach` callback, call them here. For example: -- For plugins with an `on_attach` callback, call them here. For example:
-- require('completion').on_attach() -- require('completion').on_attach()

6
runtime/lua/vim/lsp.lua
View File

@@ -1543,12 +1543,10 @@ end
--- ---
--- Currently only supports a single client. This can be set via --- Currently only supports a single client. This can be set via
--- `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` but will typically or in `on_attach` --- `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` but will typically or in `on_attach`
--- via `vim.api.nvim_buf_set_option(bufnr, 'formatexpr', 'v:lua.vim.lsp.formatexpr()')`. --- via `vim.api.nvim_buf_set_option(bufnr, 'formatexpr', 'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})')`.
---
--- Can additionally be wrapped with a function that passes an optional table for customization.
--- ---
---@param opts table options for customizing the formatting expression which takes the ---@param opts table options for customizing the formatting expression which takes the
--- following keys: --- following optional keys:
--- * timeout_ms (default 500ms). The timeout period for the formatting request. --- * timeout_ms (default 500ms). The timeout period for the formatting request.
function lsp.formatexpr(opts) function lsp.formatexpr(opts)
opts = opts or {} opts = opts or {}