From cc311dcf72be1792da063c10e453cb294fefcc3c Mon Sep 17 00:00:00 2001
From: mitchell <70453897+orbitalquark@users.noreply.github.com>
Date: Mon, 12 Oct 2020 11:51:59 -0400
Subject: Updated LuaDoc for `ui.command_entry.append_history()`. Clarify that
 it's not normally needed.

---
 modules/textadept/command_entry.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'modules/textadept/command_entry.lua')

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)
-- 
cgit v1.2.3