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 /modules/textadept | |
| parent | 0ebd2624ae677ecd4b58c8e4abd37618ab5bb0c2 (diff) | |
| download | textadept-cc311dcf72be1792da063c10e453cb294fefcc3c.tar.gz textadept-cc311dcf72be1792da063c10e453cb294fefcc3c.zip | |
Updated LuaDoc for `ui.command_entry.append_history()`.
Clarify that it's not normally needed.
Diffstat (limited to 'modules/textadept')
| -rw-r--r-- | modules/textadept/command_entry.lua | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/modules/textadept/command_entry.lua b/modules/textadept/command_entry.lua index 5c30394e..f6a82baa 100644 --- a/modules/textadept/command_entry.lua +++ b/modules/textadept/command_entry.lua @@ -37,6 +37,9 @@ end --- -- 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. -- @param text String text to append to history. -- @name append_history function M.append_history(text) |