Some documentation improvements #3799
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is still not properly documented (except for the example in tutorial.md), so document it.
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.
JoeKar
approved these changes
Jul 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
tutorial.md)MouseDragandMouseRelease*tcell.EventMouseto lua functions bound to mouse buttons (which has worked since Improve support for mouse events handling #2605 but was never documented) as well as to mouse action callbacksonMouseXXXandpreMouseXXX(which has been recently implemented in Pass mouse info to {on,pre}MouseXXX callbacks #3779)onXXXaction callbacks is used (the existing documentation for that is completely untrue: this return value not used for relocating the view or the cursor, it is used for chaining multiple actions in keybindings).