Skip to content

Commit

Permalink
chore(build): auto-generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 9, 2024
1 parent b3e2710 commit 1f9218b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,17 @@ end
This function is used to select the entry at index `index` where `index`
indicates the visible position in the menu.
This is really useful to create shortcuts to certain entries like in the
[example in configuration recipes](/configuration_recipes#labels-and-shortcuts).
[Example usage](/configuration_recipes#labels-and-shortcuts).

## Is Reversed
`api.is_reversed(): boolean`

Indicated whether the menu is reversed
Only relevant when using sorting direction "away-from-cursor"
Only relevant when using sorting direction "away-from-cursor"

## Get Documentation
`api.get_documentation(): string[]`

Get the documentation of the currently selected entry.
Will return an empty table if no documentation is available.
[Example usage](/configuration_recipes#access-documentation)

0 comments on commit 1f9218b

Please sign in to comment.