branch: externals/termint
commit 3170eae7a73039e351c50a548de7e45e6b3ff222
Author: Milan Glacier <[email protected]>
Commit: Milan Glacier <[email protected]>
doc: update docstring.
---
termint.el | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/termint.el b/termint.el
index e314c6d60c..e368e291d1 100644
--- a/termint.el
+++ b/termint.el
@@ -116,9 +116,14 @@ Each element takes the form (SUFFIX . FN). SUFFIX is a
string
appended to `termint-REPL-NAME-` to create the final command name for
every schema defined via `termint-define`. FN is the function invoked
by the generated command. It receives two arguments: REPL-NAME and
-SESSION. See `termint--hide-window` for a reference implementation of
-the expected function signature. Configure this variable before
-invoking `termint-define` to ensure the custom commands are
+SESSION. See `termint--hide-window' for a reference implementation of
+the expected function signature.
+
+For example, to generate a command named `termint-ipython-hide-window`,
+add the entry `(\"hide-window\" . termint--hide-window)' to this list.
+
+Configure this variable before
+invoking `termint-define' to ensure the custom commands are
generated."
:type '(alist :key-type string :value-type function))
