1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-23 07:19:15 +00:00

Don't start docstrings with "This function"

* lisp/calculator.el (calculator-add-operators):
* lisp/erc/erc-log.el (erc-generate-log-file-name-with-date)
(erc-generate-log-file-name-short):
* lisp/eshell/esh-mode.el (eshell-begin-on-new-line):
* lisp/progmodes/hideif.el (hif-merge-ifdef-region):
* lisp/tab-bar.el (tab-bar--event-to-item):
* lisp/textmodes/artist.el (artist-no-rb-unset-point2)
(artist-no-rb-unset-points):
* lisp/which-key.el (which-key--hide-popup): Don't start function
docstrings with "This function".
This commit is contained in:
Stefan Kangas 2024-11-01 23:56:12 +01:00
parent 471716c67d
commit 4df832750c
7 changed files with 9 additions and 9 deletions

View File

@ -775,7 +775,7 @@ Defaults to 1."
(or (nth 4 op) 1))
(defun calculator-add-operators (more-ops)
"This function handles operator addition.
"Handle operator addition.
Adds MORE-OPS to `calculator-operator', called initially to handle
`calculator-initial-operators' and `calculator-user-operators'."
(let ((added-ops nil))

View File

@ -360,13 +360,13 @@ The result is converted to lowercase, as IRC is case-insensitive."
erc-log-channels-directory)))))
(defun erc-generate-log-file-name-with-date (buffer &rest _ignore)
"This function computes a short log file name.
"Compute a short log file name with the current date.
The name of the log file is composed of BUFFER and the current date.
This function is a possible value for `erc-generate-log-file-name-function'."
(concat (buffer-name buffer) "-" (format-time-string "%Y-%m-%d") ".txt"))
(defun erc-generate-log-file-name-short (buffer &rest _ignore)
"This function computes a short log file name.
"Compute a short log file name.
In fact, it only uses the buffer name of the BUFFER argument, so
you can affect that using `rename-buffer' and the-like. This
function is a possible value for

View File

@ -537,7 +537,7 @@ Putting this function on `eshell-pre-command-hook' will mimic Plan 9's
(eshell-interactive-output-filter nil string)))
(defsubst eshell-begin-on-new-line ()
"This function outputs a newline if not at beginning of line."
"Print a newline if not at beginning of line."
(save-excursion
(goto-char eshell-last-output-end)
(or (bolp)

View File

@ -400,7 +400,7 @@ If there is a marked region from START to END it only shows the symbols within."
(end-of-line 2)))
(defun hif-merge-ifdef-region (start end)
"This function merges nearby ifdef regions to form a bigger overlay.
"Merge nearby ifdef regions to form a bigger overlay.
The region is defined by START and END. This will decrease the number of
overlays created."
;; Generally there is no need to call itself recursively since there should

View File

@ -298,7 +298,7 @@ For any other value of KEY, the value is t."
(defvar tab-bar--dragging-in-progress)
(defun tab-bar--event-to-item (posn)
"This function extracts extra info from the mouse event at position POSN.
"Extract extra info from the mouse event at position POSN.
It returns a list of the form (KEY KEY-BINDING CLOSE-P), where:
KEY is a symbol representing a tab, such as \\='tab-1 or \\='current-tab;
KEY-BINDING is the binding of KEY;

View File

@ -1997,7 +1997,7 @@ With optional argument SEE-THRU set to non-nil, text in the buffer
(aset artist-rb-save-data 6 0)))
(defun artist-no-rb-unset-point2 ()
"This function unsets point 2 when not rubber-banding."
"Unset point 2 when not rubber-banding."
(if (= (aref artist-rb-save-data 6) 1)
(let ((x-now (artist-current-column))
(y-now (artist-current-line))
@ -2020,7 +2020,7 @@ With optional argument SEE-THRU set to non-nil, text in the buffer
(aset artist-rb-save-data 6 1)))
(defun artist-no-rb-unset-points ()
"This function unsets point 1 and 2 when not rubber-banding."
"Unset point 1 and 2 when not rubber-banding."
(artist-no-rb-unset-point1)
(artist-no-rb-unset-point2))

View File

@ -1219,7 +1219,7 @@ total height."
;;; Show/hide which-key buffer
(defun which-key--hide-popup ()
"This function is called to hide the which-key buffer."
"Hide the `which-key' buffer."
(unless (or which-key-persistent-popup
(member real-this-command which-key--paging-functions))
(setq which-key--last-try-2-loc nil)