(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))
(integer :tag "Seconds")))
(defvar-local erc-server-ping-handler nil
- "This variable holds the periodic ping timer.")
+ "The periodic server ping timer.")
;;;; Helper functions
erc-log-channels-directory)))))
(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.
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.
+ "Return 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
(const :tag "Max" max)))
(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 should return a list of strings of the same number of elements.
If nil instead of a function, shortening is disabled."
:group 'eshell-smart)
(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'."
:type '(radio (const :tag "Beginning of command" begin)
(const :tag "After command word" after)
(eshell-interactive-filter nil string)))
(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
(goto-char eshell-last-output-end)
(or (bolp)
:type 'boolean)
(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
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
:group 'supercite-frames)
(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:
non-nil -- cite the entire region, regardless of its size
(dhe-kx high)
(rsa-kx high)
(cbc-cipher high))
- "This variable specifies what TLS connection checks to perform.
-It's an alist where the key is the name of the check, and the
-value is the minimum security level the check should begin.
-
-Each check function is called with the parameters HOST PORT
-STATUS SETTINGS. HOST is the host domain, PORT is a TCP port
-number, STATUS is the peer status returned by
-`gnutls-peer-status', and SETTINGS is the persistent and session
-settings for the host HOST. Please refer to the contents of
-`nsm-settings-file' for details. If a problem is found, the check
-function is required to return an error message, and nil
+ "Alist of TLS connection checks to perform.
+The key is the name of the check, and the value is the minimum security
+level the check should begin.
+
+Each check function is called with the parameters HOST PORT STATUS
+SETTINGS. HOST is the host domain, PORT is a TCP port number, STATUS is
+the peer status returned by `gnutls-peer-status', and SETTINGS is the
+persistent and session settings for the host HOST. Please refer to the
+contents of `nsm-settings-file' for details. If a problem is found, the
+check function is required to return an error message, and nil
otherwise.
See also: `nsm-check-tls-connection', `nsm-save-host-names',
#'org-element--cache-after-change -1 t)))
(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
headlines immediately after modification preserving all the unaffected
(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
"C-c C-c" #'m2-compile)
(defcustom m2-indent 5
- "This variable gives the indentation in Modula-2 mode."
+ "Indentation in Modula-2 mode."
:type 'integer
:safe (lambda (v) (or (null v) (integerp v))))
"The tail of the Scheme expressions ring whose car is the last thing yanked.")
(defvar-local xscheme-running-p nil
- "This variable, if nil, indicates that the scheme process is
-waiting for input. Otherwise, it is busy evaluating something.")
+ "If nil, the scheme process is waiting for input.
+Otherwise, it is busy evaluating something.")
(defconst xscheme-control-g-synchronization-p t
"If non-nil, insert markers in the scheme input stream to indicate when
signaled until the scheme process acknowledges receipt.")
(defvar-local xscheme-control-g-disabled-p nil
- "This variable, if non-nil, indicates that a control-g is being processed
-by the scheme process, so additional control-g's are to be ignored.")
+ "If non-nil, a control-g is being processed by the scheme process, so
+additional control-g's are to be ignored.")
(defvar xscheme-string-receiver nil
"Procedure to send the string argument from the scheme process.")
(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;
;;; 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)
projects / emacs.git / commitdiff