summaryrefslogtreecommitdiff
path: root/lisp/tab-bar.el
diff options
context:
space:
mode:
authorRobert Cochran <robert-git@cochranmail.com>2019-12-11 10:04:06 -0800
committerJuri Linkov <juri@linkov.net>2019-12-16 00:55:47 +0200
commitc46a4931b1a127f0b1a040a4a48174d4dbca8d16 (patch)
treec542fca497817f963f03f933d81db45767fbcf34 /lisp/tab-bar.el
parent9b7f0de639e024dd7e546d6cd3148deb1067bd1b (diff)
downloademacs-c46a4931b1a127f0b1a040a4a48174d4dbca8d16.tar.gz
Document variables that affect tabs in function docstrings
* lisp/tab-bar.el (tab-bar-new-tab-to): Mention tab-bar-post-open-functions in docstring. (tab-bar-close-tab): Mention tab-bar-prevent-tab-functions, tab-bar-tab-pre-close-functions, and tab-bar-close-last-tab-choice.
Diffstat (limited to 'lisp/tab-bar.el')
-rw-r--r--lisp/tab-bar.el14
1 files changed, 12 insertions, 2 deletions
diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el
index ba4bc0afcda..7e8f56de2a7 100644
--- a/lisp/tab-bar.el
+++ b/lisp/tab-bar.el
@@ -704,7 +704,10 @@ called."
(defun tab-bar-new-tab-to (&optional to-index)
"Add a new tab at the absolute position TO-INDEX.
TO-INDEX counts from 1. If no TO-INDEX is specified, then add
-a new tab at the position specified by `tab-bar-new-tab-to'."
+a new tab at the position specified by `tab-bar-new-tab-to'.
+
+After the tab is created, the hooks in
+`tab-bar-tab-post-open-functions' are run."
(interactive "P")
(let* ((tabs (funcall tab-bar-tabs-function))
(from-index (tab-bar--current-tab-index tabs))
@@ -819,7 +822,14 @@ ARG counts from 1.
Optional TO-INDEX could be specified to override the value of
`tab-bar-close-tab-select' programmatically with a position
of an existing tab to select after closing the current tab.
-TO-INDEX counts from 1."
+TO-INDEX counts from 1.
+
+The functions in `tab-bar-tab-prevent-close-functions' will be
+run to determine whether or not to close the tab.
+Just before the tab is closed, the functions in
+`tab-bar-tab-pre-close-functions' will be run. The base behavior
+for the last tab on a frame is determined by
+`tab-bar-close-last-tab-choice'."
(interactive "P")
(let* ((tabs (funcall tab-bar-tabs-function))
(current-index (tab-bar--current-tab-index tabs))