diff options
| author |  mitchell <70453897+orbitalquark@users.noreply.github.com> | 2020-10-12 11:51:59 -0400 |
|---|---|---|
| committer | mitchell <70453897+orbitalquark@users.noreply.github.com> | 2020-10-12 11:51:59 -0400 |
| commit | cc311dcf72be1792da063c10e453cb294fefcc3c (patch) | |
| tree | 1045aa1b08ac3fa2ce3efb370c7d64fb1692503d /docs | |
| parent | 0ebd2624ae677ecd4b58c8e4abd37618ab5bb0c2 (diff) | |
Updated LuaDoc for `ui.command_entry.append_history()`.
Clarify that it's not normally needed.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md index f3f8b180..9a7bcdb2 100644 --- a/docs/api.md +++ b/docs/api.md @@ -8001,6 +8001,9 @@ The height in pixels of the command entry. Appends the given text to the history for the current or most recent command entry mode. +This should only be called if `ui.command_entry.run()` is called with a keys +table that has a custom binding for the Enter key ('\n'). +Otherwise, history is automatically appended as needed. Parameters: |