From c6c4ae57b985bf9bd604613a173819fe725df761 Mon Sep 17 00:00:00 2001 From: Robert Cochran Date: Wed, 11 Dec 2019 10:04:06 -0800 Subject: [PATCH] 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. --- lisp/tab-bar.el | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el index ba4bc0afcd..7e8f56de2a 100644 --- a/lisp/tab-bar.el +++ b/lisp/tab-bar.el @@ -704,7 +704,10 @@ tab-bar-tab-post-open-functions (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 @@ tab-bar-close-tab 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)) -- 2.23.0