Skip to content

Commit

Permalink
[docgen] Update docs
Browse files Browse the repository at this point in the history 
skip-checks: true
  • Loading branch information
Github Actions committed Sep 13, 2024
1 parent 95a839f commit 183041a
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 36 deletions.
34 changes: 18 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,28 +307,30 @@ Update the quickfix list with the current buffer text for each item.
`toggle(opts)` \
Toggle the quickfix or loclist window.

| Param | Type | Desc | |
| ----- | ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
| opts | `nil\|quicker.OpenOpts` | | |
| | loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
| | focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
| | height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
| | min_height | `nil\|integer` | Minimum height of the quickfix window. Default 4. |
| | max_height | `nil\|integer` | Maximum height of the quickfix window. Default 10. |
| Param | Type | Desc | |
| ----- | ----------------------- | -------------------------- | ----------------------------------------------------------------------------------- |
| opts | `nil\|quicker.OpenOpts` | | |
| | loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
| | focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
| | height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
| | min_height | `nil\|integer` | Minimum height of the quickfix window. Default 4. |
| | max_height | `nil\|integer` | Maximum height of the quickfix window. Default 10. |
| | open_cmd_mods | `nil\|quicker.OpenCmdMods` | A table of modifiers for the quickfix or loclist open commands. |

### open(opts)

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

| Param | Type | Desc | |
| ----- | ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
| opts | `nil\|quicker.OpenOpts` | | |
| | loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
| | focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
| | height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
| | min_height | `nil\|integer` | Minimum height of the quickfix window. Default 4. |
| | max_height | `nil\|integer` | Maximum height of the quickfix window. Default 10. |
| Param | Type | Desc | |
| ----- | ----------------------- | -------------------------- | ----------------------------------------------------------------------------------- |
| opts | `nil\|quicker.OpenOpts` | | |
| | loclist | `nil\|boolean` | Toggle the loclist instead of the quickfix list |
| | focus | `nil\|boolean` | Focus the quickfix window after toggling (default false) |
| | height | `nil\|integer` | Height of the quickfix window when opened. Defaults to number of items in the list. |
| | min_height | `nil\|integer` | Minimum height of the quickfix window. Default 4. |
| | max_height | `nil\|integer` | Maximum height of the quickfix window. Default 10. |
| | open_cmd_mods | `nil\|quicker.OpenCmdMods` | A table of modifiers for the quickfix or loclist open commands. |

### close(opts)

Expand Down
44 changes: 24 additions & 20 deletions doc/quicker.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,32 +123,36 @@ toggle({opts}) *quicker.toggl

Parameters:
{opts} `nil|quicker.OpenOpts`
{loclist} `nil|boolean` Toggle the loclist instead of the quickfix
list
{focus} `nil|boolean` Focus the quickfix window after toggling
(default false)
{height} `nil|integer` Height of the quickfix window when opened.
Defaults to number of items in the list.
{min_height} `nil|integer` Minimum height of the quickfix window.
Default 4.
{max_height} `nil|integer` Maximum height of the quickfix window.
Default 10.
{loclist} `nil|boolean` Toggle the loclist instead of the
quickfix list
{focus} `nil|boolean` Focus the quickfix window after toggling
(default false)
{height} `nil|integer` Height of the quickfix window when
opened. Defaults to number of items in the list.
{min_height} `nil|integer` Minimum height of the quickfix window.
Default 4.
{max_height} `nil|integer` Maximum height of the quickfix window.
Default 10.
{open_cmd_mods} `nil|quicker.OpenCmdMods` A table of modifiers for the
quickfix or loclist open commands.

open({opts}) *quicker.open*
Open the quickfix or loclist window.

Parameters:
{opts} `nil|quicker.OpenOpts`
{loclist} `nil|boolean` Toggle the loclist instead of the quickfix
list
{focus} `nil|boolean` Focus the quickfix window after toggling
(default false)
{height} `nil|integer` Height of the quickfix window when opened.
Defaults to number of items in the list.
{min_height} `nil|integer` Minimum height of the quickfix window.
Default 4.
{max_height} `nil|integer` Maximum height of the quickfix window.
Default 10.
{loclist} `nil|boolean` Toggle the loclist instead of the
quickfix list
{focus} `nil|boolean` Focus the quickfix window after toggling
(default false)
{height} `nil|integer` Height of the quickfix window when
opened. Defaults to number of items in the list.
{min_height} `nil|integer` Minimum height of the quickfix window.
Default 4.
{max_height} `nil|integer` Maximum height of the quickfix window.
Default 10.
{open_cmd_mods} `nil|quicker.OpenCmdMods` A table of modifiers for the
quickfix or loclist open commands.

close({opts}) *quicker.close*
Close the quickfix or loclist window.
Expand Down

0 comments on commit 183041a

Please sign in to comment.