github/zyedidia.micro
2
0
Fork 0
mirror of https://github.com/zyedidia/micro.git synced 2026-03-17 22:37:10 +09:00
Code Issues Packages Projects Releases Wiki Activity

help: Update and correct documentation for onAction return value

Browse Source 
The documentation says that the returned value of onAction callbacks
is used for determining whether the view should be relocated, which
has nothing to do with reality, this returned value is used for a
completely different thing. So update the docs accordingly.
This commit is contained in:
Dmytro Maluka
2025-07-05 16:09:55 +02:00
parent ffdd4b43dd
commit c267c7c9aa
2 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
runtime/help/keybindings.md
View File

@@ -70,6 +70,13 @@ will execute `InsertTab`. To use `,`, `|` or `&` in an action (as an argument
to a command, for example), escape it with `\` or wrap it in single or double
quotes.
If the action has an `onAction` lua callback, for example `onAutocomplete` (see
`> help plugins`), then the action is only considered successful if the action
itself succeeded *and* the callback returned true. If there are multiple
`onAction` callbacks for this action, registered by multiple plugins, then the
action is only considered successful if the action itself succeeded and all the
callbacks returned true.
## Binding commands
You can also bind a key to execute a command in command mode (see

9
runtime/help/plugins.md
View File

@@ -71,8 +71,10 @@ that micro defines:
* `onAction(bufpane)`: runs when `Action` is triggered by the user, where
`Action` is a bindable action (see `> help keybindings`). A bufpane
is passed as input and the function should return a boolean defining
whether the view should be relocated after this action is performed.
is passed as input. The function should return a boolean defining
whether the action was successful, which is used when the action is
chained with other actions (see `> help keybindings`) to determine whether
the next actions in the chain should be executed or not.
* `preAction(bufpane)`: runs immediately before `Action` is triggered
by the user. Returns a boolean which defines whether the action should
@@ -101,9 +103,6 @@ within. This is almost always the current bufpane.
All available actions are listed in the keybindings section of the help.
These functions should also return a boolean specifying whether the bufpane
should be relocated to the cursor or not after the action is complete.
## Accessing micro functions
Some of micro's internal information is exposed in the form of packages, which