aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJon Heinritz <jon.heinritz@protonmail.com>2024-05-22 01:24:14 +0200
committerGitHub <noreply@github.com>2024-05-21 16:24:14 -0700
commitb8f3ed3903430033f638b17f7455b8fd3d6a85b5 (patch)
tree41806a1c4e413eae93c8eb8953cad2d4f9074c9c /README.md
parent00f9d91391b04b1935e2f15948bd96cc111e7d3a (diff)
docs: better type definitions for top-level functions (#410)
* docs: extract conform.format(opts) into it's own class * docs: extract conform.format_lines(opts) into it's own class * refactor: use new nvim_doc_tools capability to remove duplicated class definition --------- Co-authored-by: Steven Arcangeli <stevearc@stevearc.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 66912cb..356dea9 100644
--- a/README.md
+++ b/README.md
@@ -538,7 +538,7 @@ Format a buffer
| Param | Type | Desc | |
| -------- | ---------------------------------------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| opts | `nil\|table` | | |
+| opts | `nil\|conform.FormatOpts` | | |
| | timeout_ms | `nil\|integer` | Time in milliseconds to block for formatting. Defaults to 1000. No effect if async = true. |
| | bufnr | `nil\|integer` | Format this buffer (default 0) |
| | async | `nil\|boolean` | If true the method won't block. Defaults to false. If the buffer is modified before the formatter completes, the formatting will be discarded. |