aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/erc
diff options
context:
space:
mode:
authorStefan Kangas2024-12-26 21:02:45 +0100
committerStefan Kangas2024-12-26 21:02:45 +0100
commit186ea407326166ee4669ce6fe84871c1e16c657c (patch)
treee86a05cf2e5b781c7175b6dda1a76d0f475cec75 /lisp/erc
parentcb8ce2e68bb68844971695e139ae93bd320bc0d8 (diff)
downloademacs-186ea407326166ee4669ce6fe84871c1e16c657c.tar.gz
emacs-186ea407326166ee4669ce6fe84871c1e16c657c.zip
Don't start docstrings with "This function" or similar
* lisp/calculator.el (calculator-add-operators): * lisp/erc/erc-backend.el (erc-server-ping-handler): * lisp/erc/erc-log.el (erc-generate-log-file-name-with-date): (erc-generate-log-file-name-short): * lisp/erc/erc-track.el (erc-track-shorten-function): * lisp/eshell/em-smart.el (eshell-where-to-jump): * lisp/eshell/esh-mode.el (eshell-begin-on-new-line): * lisp/gnus/gnus-art.el (gnus-prompt-before-saving): * lisp/mail/supercite.el (sc-cite-region-limit): * lisp/net/nsm.el (network-security-protocol-checks): * lisp/org/org-element.el (org-element--cache-avoid-synchronous-headline-re-parsing): * lisp/progmodes/hideif.el (hif-merge-ifdef-region): * lisp/progmodes/modula2.el (m2-indent): * lisp/progmodes/xscheme.el (xscheme-running-p): (xscheme-control-g-disabled-p): * lisp/tab-bar.el (tab-bar--event-to-item): * lisp/which-key.el (which-key--hide-popup): Don't start docstrings with "This function" or "This variable".
Diffstat (limited to 'lisp/erc')
-rw-r--r--lisp/erc/erc-backend.el2
-rw-r--r--lisp/erc/erc-log.el4
-rw-r--r--lisp/erc/erc-track.el2
3 files changed, 4 insertions, 4 deletions
diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el
index 9aedc110067..0720e46ef6b 100644
--- a/lisp/erc/erc-backend.el
+++ b/lisp/erc/erc-backend.el
@@ -570,7 +570,7 @@ If this is set to nil, never try to reconnect."
570 (integer :tag "Seconds"))) 570 (integer :tag "Seconds")))
571 571
572(defvar-local erc-server-ping-handler nil 572(defvar-local erc-server-ping-handler nil
573 "This variable holds the periodic ping timer.") 573 "The periodic server ping timer.")
574 574
575;;;; Helper functions 575;;;; Helper functions
576 576
diff --git a/lisp/erc/erc-log.el b/lisp/erc/erc-log.el
index 66420662c23..b37fa086a0e 100644
--- a/lisp/erc/erc-log.el
+++ b/lisp/erc/erc-log.el
@@ -352,13 +352,13 @@ The result is converted to lowercase, as IRC is case-insensitive."
352 erc-log-channels-directory))))) 352 erc-log-channels-directory)))))
353 353
354(defun erc-generate-log-file-name-with-date (buffer &rest _ignore) 354(defun erc-generate-log-file-name-with-date (buffer &rest _ignore)
355 "This function computes a short log file name. 355 "Return a short log file name with the current date.
356The name of the log file is composed of BUFFER and the current date. 356The name of the log file is composed of BUFFER and the current date.
357This function is a possible value for `erc-generate-log-file-name-function'." 357This function is a possible value for `erc-generate-log-file-name-function'."
358 (concat (buffer-name buffer) "-" (format-time-string "%Y-%m-%d") ".txt")) 358 (concat (buffer-name buffer) "-" (format-time-string "%Y-%m-%d") ".txt"))
359 359
360(defun erc-generate-log-file-name-short (buffer &rest _ignore) 360(defun erc-generate-log-file-name-short (buffer &rest _ignore)
361 "This function computes a short log file name. 361 "Return a short log file name.
362In fact, it only uses the buffer name of the BUFFER argument, so 362In fact, it only uses the buffer name of the BUFFER argument, so
363you can affect that using `rename-buffer' and the-like. This 363you can affect that using `rename-buffer' and the-like. This
364function is a possible value for 364function is a possible value for
diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el
index 39a4775ddca..6c91d88a168 100644
--- a/lisp/erc/erc-track.el
+++ b/lisp/erc/erc-track.el
@@ -140,7 +140,7 @@ This setting is used by `erc-track-shorten-names'."
140 (const :tag "Max" max))) 140 (const :tag "Max" max)))
141 141
142(defcustom erc-track-shorten-function 'erc-track-shorten-names 142(defcustom erc-track-shorten-function 'erc-track-shorten-names
143 "This function will be used to reduce the channel names before display. 143 "Function used to reduce the channel names before display.
144It takes one argument, CHANNEL-NAMES which is a list of strings. 144It takes one argument, CHANNEL-NAMES which is a list of strings.
145It should return a list of strings of the same number of elements. 145It should return a list of strings of the same number of elements.
146If nil instead of a function, shortening is disabled." 146If nil instead of a function, shortening is disabled."