Skip to content

Commit 1280ba5

Browse files
author
Github Actions
committed
[docgen] Update docs
skip-checks: true
1 parent b9b7eec commit 1280ba5

File tree

2 files changed

+28
-20
lines changed

2 files changed

+28
-20
lines changed

‎README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -324,31 +324,31 @@ Update the quickfix list with the current buffer text for each item.
324324
`toggle(opts)` \
325325
Toggle the quickfix or loclist window.
326326

327-
| Param | Type | Desc |
328-
| -------------- | -------------------------- | ------------------------------------------------------------------------------------------- |
329-
| opts | `nil\|quicker.OpenOpts` | |
330-
| >loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
331-
| >focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
332-
| >height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
333-
| >min_height | `nil\|integer` | Minimum height of the quickfix window. Ignored if height is defined explicitly. Default 4. |
334-
| >max_height | `nil\|integer` | Maximum height of the quickfix window. Ignored if height is defined explicitly. Default 16. |
335-
| >open_cmd_mods | `nil\|quicker.OpenCmdMods` | A table of modifiers for the quickfix or loclist open commands. |
327+
| Param | Type | Desc |
328+
| -------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
329+
| opts | `nil\|quicker.OpenOpts` | |
330+
| >loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
331+
| >focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
332+
| >height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
333+
| >min_height | `nil\|integer` | Minimum height of the quickfix window. Default 4. |
334+
| >max_height | `nil\|integer` | Maximum height of the quickfix window. Default 16. |
335+
| >open_cmd_mods | `nil\|quicker.OpenCmdMods` | A table of modifiers for the quickfix or loclist open commands. |
336336
| >view | `nil\|quicker.WinViewDict` | A table of options to restore the view of the quickfix window. Can be used to set the cursor or scroll positions (see `winsaveview()`). |
337337

338338
### open(opts)
339339

340340
`open(opts)` \
341341
Open the quickfix or loclist window.
342342

343-
| Param | Type | Desc |
344-
| -------------- | -------------------------- | ------------------------------------------------------------------------------------------- |
345-
| opts | `nil\|quicker.OpenOpts` | |
346-
| >loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
347-
| >focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
348-
| >height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
349-
| >min_height | `nil\|integer` | Minimum height of the quickfix window. Ignored if height is defined explicitly. Default 4. |
350-
| >max_height | `nil\|integer` | Maximum height of the quickfix window. Ignored if height is defined explicitly. Default 16. |
351-
| >open_cmd_mods | `nil\|quicker.OpenCmdMods` | A table of modifiers for the quickfix or loclist open commands. |
343+
| Param | Type | Desc |
344+
| -------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
345+
| opts | `nil\|quicker.OpenOpts` | |
346+
| >loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
347+
| >focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
348+
| >height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
349+
| >min_height | `nil\|integer` | Minimum height of the quickfix window. Default 4. |
350+
| >max_height | `nil\|integer` | Maximum height of the quickfix window. Default 16. |
351+
| >open_cmd_mods | `nil\|quicker.OpenCmdMods` | A table of modifiers for the quickfix or loclist open commands. |
352352
| >view | `nil\|quicker.WinViewDict` | A table of options to restore the view of the quickfix window. Can be used to set the cursor or scroll positions (see `winsaveview()`). |
353353

354354
### close(opts)

‎doc/quicker.txt‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,13 @@ toggle({opts}) *quicker.toggl
148148
{min_height} `nil|integer` Minimum height of the quickfix window.
149149
Default 4.
150150
{max_height} `nil|integer` Maximum height of the quickfix window.
151-
Default 10.
151+
Default 16.
152152
{open_cmd_mods} `nil|quicker.OpenCmdMods` A table of modifiers for the
153153
quickfix or loclist open commands.
154+
{view} `nil|quicker.WinViewDict` A table of options to
155+
restore the view of the quickfix window. Can be used
156+
to set the cursor or scroll positions (see
157+
`winsaveview()`).
154158

155159
open({opts}) *quicker.open*
156160
Open the quickfix or loclist window.
@@ -166,9 +170,13 @@ open({opts}) *quicker.ope
166170
{min_height} `nil|integer` Minimum height of the quickfix window.
167171
Default 4.
168172
{max_height} `nil|integer` Maximum height of the quickfix window.
169-
Default 10.
173+
Default 16.
170174
{open_cmd_mods} `nil|quicker.OpenCmdMods` A table of modifiers for the
171175
quickfix or loclist open commands.
176+
{view} `nil|quicker.WinViewDict` A table of options to
177+
restore the view of the quickfix window. Can be used
178+
to set the cursor or scroll positions (see
179+
`winsaveview()`).
172180

173181
close({opts}) *quicker.close*
174182
Close the quickfix or loclist window.

0 commit comments

Comments
 (0)