aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept
diff options
context:
space:
mode:
Diffstat (limited to 'modules/textadept')
-rw-r--r--modules/textadept/command_entry.lua3
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)