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".
This commit is contained in:
Stefan Kangas 2024-12-26 21:02:45 +01:00
parent cb8ce2e68b
commit 186ea40732
15 changed files with 27 additions and 28 deletions

View file

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

View file

@ -570,7 +570,7 @@ If this is set to nil, never try to reconnect."
(integer :tag "Seconds"))) (integer :tag "Seconds")))
(defvar-local erc-server-ping-handler nil (defvar-local erc-server-ping-handler nil
"This variable holds the periodic ping timer.") "The periodic server ping timer.")
;;;; Helper functions ;;;; Helper functions

View file

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

View file

@ -140,7 +140,7 @@ This setting is used by `erc-track-shorten-names'."
(const :tag "Max" max))) (const :tag "Max" max)))
(defcustom erc-track-shorten-function 'erc-track-shorten-names (defcustom erc-track-shorten-function 'erc-track-shorten-names
"This function will be used to reduce the channel names before display. "Function used to reduce the channel names before display.
It takes one argument, CHANNEL-NAMES which is a list of strings. It takes one argument, CHANNEL-NAMES which is a list of strings.
It should return a list of strings of the same number of elements. It should return a list of strings of the same number of elements.
If nil instead of a function, shortening is disabled." If nil instead of a function, shortening is disabled."

View file

@ -150,7 +150,7 @@ buffer using \\[end-of-buffer]."
:group 'eshell-smart) :group 'eshell-smart)
(defcustom eshell-where-to-jump 'begin (defcustom eshell-where-to-jump 'begin
"This variable indicates where point should jump to after a command. "The location where point should jump to after a command.
The options are `begin', `after' or `end'." The options are `begin', `after' or `end'."
:type '(radio (const :tag "Beginning of command" begin) :type '(radio (const :tag "Beginning of command" begin)
(const :tag "After command word" after) (const :tag "After command word" after)

View file

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

View file

@ -512,7 +512,7 @@ might have."
:type 'boolean) :type 'boolean)
(defcustom gnus-prompt-before-saving 'always (defcustom gnus-prompt-before-saving 'always
"This variable says how much prompting is to be done when saving articles. "How much prompting to do when saving articles.
If it is nil, no prompting will be done, and the articles will be If it is nil, no prompting will be done, and the articles will be
saved to the default files. If this variable is `always', each and saved to the default files. If this variable is `always', each and
every article that is saved will be preceded by a prompt, even when every article that is saved will be preceded by a prompt, even when

View file

@ -236,7 +236,7 @@ See the variable `sc-cite-frame-alist' for details."
:group 'supercite-frames) :group 'supercite-frames)
(defcustom sc-cite-region-limit t (defcustom sc-cite-region-limit t
"This variable controls automatic citation of yanked text. "Size limit for automatic citation of yanked text.
Valid values are: Valid values are:
non-nil -- cite the entire region, regardless of its size non-nil -- cite the entire region, regardless of its size

View file

@ -155,17 +155,16 @@ unencrypted."
(dhe-kx high) (dhe-kx high)
(rsa-kx high) (rsa-kx high)
(cbc-cipher high)) (cbc-cipher high))
"This variable specifies what TLS connection checks to perform. "Alist of TLS connection checks to perform.
It's an alist where the key is the name of the check, and the The key is the name of the check, and the value is the minimum security
value is the minimum security level the check should begin. level the check should begin.
Each check function is called with the parameters HOST PORT Each check function is called with the parameters HOST PORT STATUS
STATUS SETTINGS. HOST is the host domain, PORT is a TCP port SETTINGS. HOST is the host domain, PORT is a TCP port number, STATUS is
number, STATUS is the peer status returned by the peer status returned by `gnutls-peer-status', and SETTINGS is the
`gnutls-peer-status', and SETTINGS is the persistent and session persistent and session settings for the host HOST. Please refer to the
settings for the host HOST. Please refer to the contents of contents of `nsm-settings-file' for details. If a problem is found, the
`nsm-settings-file' for details. If a problem is found, the check check function is required to return an error message, and nil
function is required to return an error message, and nil
otherwise. otherwise.
See also: `nsm-check-tls-connection', `nsm-save-host-names', See also: `nsm-check-tls-connection', `nsm-save-host-names',

View file

@ -7259,7 +7259,7 @@ that range. See `after-change-functions' for more information."
#'org-element--cache-after-change -1 t))) #'org-element--cache-after-change -1 t)))
(defvar org-element--cache-avoid-synchronous-headline-re-parsing nil (defvar org-element--cache-avoid-synchronous-headline-re-parsing nil
"This variable controls how buffer changes are handled by the cache. "How buffer changes are handled by the cache.
By default (when this variable is nil), cache re-parses modified By default (when this variable is nil), cache re-parses modified
headlines immediately after modification preserving all the unaffected headlines immediately after modification preserving all the unaffected

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))) (end-of-line 2)))
(defun hif-merge-ifdef-region (start end) (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 The region is defined by START and END. This will decrease the number of
overlays created." overlays created."
;; Generally there is no need to call itself recursively since there should ;; Generally there is no need to call itself recursively since there should

View file

@ -97,7 +97,7 @@
"C-c C-c" #'m2-compile) "C-c C-c" #'m2-compile)
(defcustom m2-indent 5 (defcustom m2-indent 5
"This variable gives the indentation in Modula-2 mode." "Indentation in Modula-2 mode."
:type 'integer :type 'integer
:safe (lambda (v) (or (null v) (integerp v)))) :safe (lambda (v) (or (null v) (integerp v))))

View file

@ -55,8 +55,8 @@
"The tail of the Scheme expressions ring whose car is the last thing yanked.") "The tail of the Scheme expressions ring whose car is the last thing yanked.")
(defvar-local xscheme-running-p nil (defvar-local xscheme-running-p nil
"This variable, if nil, indicates that the scheme process is "If nil, the scheme process is waiting for input.
waiting for input. Otherwise, it is busy evaluating something.") Otherwise, it is busy evaluating something.")
(defconst xscheme-control-g-synchronization-p t (defconst xscheme-control-g-synchronization-p t
"If non-nil, insert markers in the scheme input stream to indicate when "If non-nil, insert markers in the scheme input stream to indicate when
@ -64,8 +64,8 @@ control-g interrupts were signaled. Do not allow more control-g's to be
signaled until the scheme process acknowledges receipt.") signaled until the scheme process acknowledges receipt.")
(defvar-local xscheme-control-g-disabled-p nil (defvar-local xscheme-control-g-disabled-p nil
"This variable, if non-nil, indicates that a control-g is being processed "If non-nil, a control-g is being processed by the scheme process, so
by the scheme process, so additional control-g's are to be ignored.") additional control-g's are to be ignored.")
(defvar xscheme-string-receiver nil (defvar xscheme-string-receiver nil
"Procedure to send the string argument from the scheme process.") "Procedure to send the string argument from the scheme process.")

View file

@ -298,7 +298,7 @@ For any other value of KEY, the value is t."
(defvar tab-bar--dragging-in-progress) (defvar tab-bar--dragging-in-progress)
(defun tab-bar--event-to-item (posn) (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: 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 is a symbol representing a tab, such as \\='tab-1 or \\='current-tab;
KEY-BINDING is the binding of KEY; KEY-BINDING is the binding of KEY;

View file

@ -1220,7 +1220,7 @@ total height."
;;; Show/hide which-key buffer ;;; Show/hide which-key buffer
(defun which-key--hide-popup () (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 (unless (or which-key-persistent-popup
(member real-this-command which-key--paging-functions)) (member real-this-command which-key--paging-functions))
(setq which-key--last-try-2-loc nil) (setq which-key--last-try-2-loc nil)