aboutsummaryrefslogtreecommitdiffstats
path: root/doc/conform.txt
diff options
context:
space:
mode:
authorSteven Arcangeli <stevearc@stevearc.com>2023-09-13 18:47:29 -0700
committerSteven Arcangeli <stevearc@stevearc.com>2023-09-13 18:47:29 -0700
commite9cc79fd723afccb8c0c16342b913fa6e96879b0 (patch)
treefafdba0e4dac6cc9f7c5aa149b06aaeca42abc52 /doc/conform.txt
parente18cdaf529b94465592d0c2afe1b62bc26155070 (diff)
doc: document the format options that are passed through to LSP formatting
Diffstat (limited to 'doc/conform.txt')
-rw-r--r--doc/conform.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/conform.txt b/doc/conform.txt
index a62eca8..0052326 100644
--- a/doc/conform.txt
+++ b/doc/conform.txt
@@ -115,6 +115,12 @@ format({opts}, {callback}): boolean *conform.forma
{range} `nil|table` Range to format. Table must contain `start`
and `end` keys with {row, col} tuples using (1,0)
indexing. Defaults to current selection in visual mode
+ {id} `nil|integer` Passed to |vim.lsp.buf.format| when
+ lsp_fallback = true
+ {name} `nil|string` Passed to |vim.lsp.buf.format| when
+ lsp_fallback = true
+ {filter} `nil|fun(client: table): boolean` Passed to
+ |vim.lsp.buf.format| when lsp_fallback = true
{callback} `nil|fun(err: nil|string)` Called once formatting has completed
Returns:
`boolean` True if any formatters were attempted