aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorStefan Kangas2024-11-01 23:56:12 +0100
committerStefan Kangas2024-11-01 23:56:12 +0100
commit4df832750c811abc5ccbe7bfcefe1ad8f144af8e (patch)
tree8c69b58b4742d872364a5fb61aaf41510955aede /lisp
parent471716c67d0d00a2e90dd7dfbc2bb88820a248a2 (diff)
downloademacs-4df832750c811abc5ccbe7bfcefe1ad8f144af8e.tar.gz
emacs-4df832750c811abc5ccbe7bfcefe1ad8f144af8e.zip
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".
Diffstat (limited to 'lisp')
-rw-r--r--lisp/calculator.el2
-rw-r--r--lisp/erc/erc-log.el4
-rw-r--r--lisp/eshell/esh-mode.el2
-rw-r--r--lisp/progmodes/hideif.el2
-rw-r--r--lisp/tab-bar.el2
-rw-r--r--lisp/textmodes/artist.el4
-rw-r--r--lisp/which-key.el2
7 files changed, 9 insertions, 9 deletions
diff --git a/lisp/calculator.el b/lisp/calculator.el
index a9fe76259a8..0764a16370c 100644
--- a/lisp/calculator.el
+++ b/lisp/calculator.el
@@ -775,7 +775,7 @@ Defaults to 1."
775 (or (nth 4 op) 1)) 775 (or (nth 4 op) 1))
776 776
777(defun calculator-add-operators (more-ops) 777(defun calculator-add-operators (more-ops)
778 "This function handles operator addition. 778 "Handle operator addition.
779Adds MORE-OPS to `calculator-operator', called initially to handle 779Adds MORE-OPS to `calculator-operator', called initially to handle
780`calculator-initial-operators' and `calculator-user-operators'." 780`calculator-initial-operators' and `calculator-user-operators'."
781 (let ((added-ops nil)) 781 (let ((added-ops nil))
diff --git a/lisp/erc/erc-log.el b/lisp/erc/erc-log.el
index 8311359ed09..a1102ebdcdf 100644
--- a/lisp/erc/erc-log.el
+++ b/lisp/erc/erc-log.el
@@ -360,13 +360,13 @@ The result is converted to lowercase, as IRC is case-insensitive."
360 erc-log-channels-directory))))) 360 erc-log-channels-directory)))))
361 361
362(defun erc-generate-log-file-name-with-date (buffer &rest _ignore) 362(defun erc-generate-log-file-name-with-date (buffer &rest _ignore)
363 "This function computes a short log file name. 363 "Compute a short log file name with the current date.
364The name of the log file is composed of BUFFER and the current date. 364The name of the log file is composed of BUFFER and the current date.
365This function is a possible value for `erc-generate-log-file-name-function'." 365This function is a possible value for `erc-generate-log-file-name-function'."
366 (concat (buffer-name buffer) "-" (format-time-string "%Y-%m-%d") ".txt")) 366 (concat (buffer-name buffer) "-" (format-time-string "%Y-%m-%d") ".txt"))
367 367
368(defun erc-generate-log-file-name-short (buffer &rest _ignore) 368(defun erc-generate-log-file-name-short (buffer &rest _ignore)
369 "This function computes a short log file name. 369 "Compute a short log file name.
370In fact, it only uses the buffer name of the BUFFER argument, so 370In fact, it only uses the buffer name of the BUFFER argument, so
371you can affect that using `rename-buffer' and the-like. This 371you can affect that using `rename-buffer' and the-like. This
372function is a possible value for 372function is a possible value for
diff --git a/lisp/eshell/esh-mode.el b/lisp/eshell/esh-mode.el
index c86e3cc002c..4f94934fccd 100644
--- a/lisp/eshell/esh-mode.el
+++ b/lisp/eshell/esh-mode.el
@@ -537,7 +537,7 @@ Putting this function on `eshell-pre-command-hook' will mimic Plan 9's
537 (eshell-interactive-output-filter nil string))) 537 (eshell-interactive-output-filter nil string)))
538 538
539(defsubst eshell-begin-on-new-line () 539(defsubst eshell-begin-on-new-line ()
540 "This function outputs a newline if not at beginning of line." 540 "Print a newline if not at beginning of line."
541 (save-excursion 541 (save-excursion
542 (goto-char eshell-last-output-end) 542 (goto-char eshell-last-output-end)
543 (or (bolp) 543 (or (bolp)
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el
index 9bcac0d8dc5..27a02e9805f 100644
--- a/lisp/progmodes/hideif.el
+++ b/lisp/progmodes/hideif.el
@@ -400,7 +400,7 @@ If there is a marked region from START to END it only shows the symbols within."
400 (end-of-line 2))) 400 (end-of-line 2)))
401 401
402(defun hif-merge-ifdef-region (start end) 402(defun hif-merge-ifdef-region (start end)
403 "This function merges nearby ifdef regions to form a bigger overlay. 403 "Merge nearby ifdef regions to form a bigger overlay.
404The region is defined by START and END. This will decrease the number of 404The region is defined by START and END. This will decrease the number of
405overlays created." 405overlays created."
406 ;; Generally there is no need to call itself recursively since there should 406 ;; Generally there is no need to call itself recursively since there should
diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el
index 7fc04ab3c32..faf5df541e0 100644
--- a/lisp/tab-bar.el
+++ b/lisp/tab-bar.el
@@ -298,7 +298,7 @@ For any other value of KEY, the value is t."
298(defvar tab-bar--dragging-in-progress) 298(defvar tab-bar--dragging-in-progress)
299 299
300(defun tab-bar--event-to-item (posn) 300(defun tab-bar--event-to-item (posn)
301 "This function extracts extra info from the mouse event at position POSN. 301 "Extract extra info from the mouse event at position POSN.
302It returns a list of the form (KEY KEY-BINDING CLOSE-P), where: 302It returns a list of the form (KEY KEY-BINDING CLOSE-P), where:
303 KEY is a symbol representing a tab, such as \\='tab-1 or \\='current-tab; 303 KEY is a symbol representing a tab, such as \\='tab-1 or \\='current-tab;
304 KEY-BINDING is the binding of KEY; 304 KEY-BINDING is the binding of KEY;
diff --git a/lisp/textmodes/artist.el b/lisp/textmodes/artist.el
index c736f694083..eadf0988805 100644
--- a/lisp/textmodes/artist.el
+++ b/lisp/textmodes/artist.el
@@ -1997,7 +1997,7 @@ With optional argument SEE-THRU set to non-nil, text in the buffer
1997 (aset artist-rb-save-data 6 0))) 1997 (aset artist-rb-save-data 6 0)))
1998 1998
1999(defun artist-no-rb-unset-point2 () 1999(defun artist-no-rb-unset-point2 ()
2000 "This function unsets point 2 when not rubber-banding." 2000 "Unset point 2 when not rubber-banding."
2001 (if (= (aref artist-rb-save-data 6) 1) 2001 (if (= (aref artist-rb-save-data 6) 1)
2002 (let ((x-now (artist-current-column)) 2002 (let ((x-now (artist-current-column))
2003 (y-now (artist-current-line)) 2003 (y-now (artist-current-line))
@@ -2020,7 +2020,7 @@ With optional argument SEE-THRU set to non-nil, text in the buffer
2020 (aset artist-rb-save-data 6 1))) 2020 (aset artist-rb-save-data 6 1)))
2021 2021
2022(defun artist-no-rb-unset-points () 2022(defun artist-no-rb-unset-points ()
2023 "This function unsets point 1 and 2 when not rubber-banding." 2023 "Unset point 1 and 2 when not rubber-banding."
2024 (artist-no-rb-unset-point1) 2024 (artist-no-rb-unset-point1)
2025 (artist-no-rb-unset-point2)) 2025 (artist-no-rb-unset-point2))
2026 2026
diff --git a/lisp/which-key.el b/lisp/which-key.el
index 232145f7fb5..1da9a25090f 100644
--- a/lisp/which-key.el
+++ b/lisp/which-key.el
@@ -1219,7 +1219,7 @@ total height."
1219;;; Show/hide which-key buffer 1219;;; Show/hide which-key buffer
1220 1220
1221(defun which-key--hide-popup () 1221(defun which-key--hide-popup ()
1222 "This function is called to hide the which-key buffer." 1222 "Hide the `which-key' buffer."
1223 (unless (or which-key-persistent-popup 1223 (unless (or which-key-persistent-popup
1224 (member real-this-command which-key--paging-functions)) 1224 (member real-this-command which-key--paging-functions))
1225 (setq which-key--last-try-2-loc nil) 1225 (setq which-key--last-try-2-loc nil)