; Minor stylistic fixes found by checkdoc

16 files changed, 78 insertions, 75 deletions

diff --git a/lisp/erc/erc-autoaway.el b/lisp/erc/erc-autoaway.el
index 1a13aa95cd2..bbab37fd5d5 100644
--- a/lisp/erc/erc-autoaway.el
+++ b/lisp/erc/erc-autoaway.el
@@ -183,7 +183,7 @@ See `erc-auto-discard-away'."
 
 (defcustom erc-autoaway-idle-seconds 1800
   "Number of seconds after which ERC will set you automatically away.
-If you are changing this variable using lisp instead of customizing it,
+If you are changing this variable using Lisp instead of customizing it,
 you have to run `erc-autoaway-reestablish-idletimer' afterwards."
   :set (lambda (sym val)
 	 (set-default sym val)
diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el
index fc72f324eb9..4e9547dfde1 100644
--- a/lisp/erc/erc-button.el
+++ b/lisp/erc/erc-button.el
@@ -24,7 +24,7 @@
 
 ;;; Commentary:
 
-;; Heavily borrowed from gnus-art.el. Thanks to the original authors.
+;; Heavily borrowed from gnus-art.el.  Thanks to the original authors.
 ;; This buttonizes nicks and other stuff to make it all clickable.
 ;; To enable, add to your init file:
 ;; (require 'erc-button)
@@ -165,7 +165,7 @@ REGEXP is the string matching text around the button or a symbol
 BUTTON is the number of the regexp grouping actually matching the
   button.  This is ignored if REGEXP is \\='nicknames.
 
-FORM is a lisp expression which must eval to true for the button to
+FORM is a Lisp expression which must eval to true for the button to
   be added.
 
 CALLBACK is the function to call when the user push this button.
diff --git a/lisp/erc/erc-ibuffer.el b/lisp/erc/erc-ibuffer.el
index 31e59a6d3e4..95eab040449 100644
--- a/lisp/erc/erc-ibuffer.el
+++ b/lisp/erc/erc-ibuffer.el
@@ -38,17 +38,16 @@
   :group 'erc)
 
 (defcustom erc-ibuffer-keyword-char ?k
-  "Char used to indicate a channel which had keyword traffic lately (hidden)."
+  "Char indicating a channel which had keyword traffic lately (hidden)."
   :type 'character)
 (defcustom erc-ibuffer-pal-char ?p
-  "Char used to indicate a channel which had pal traffic lately (hidden)."
+  "Char indicating a channel which had pal traffic lately (hidden)."
   :type 'character)
 (defcustom erc-ibuffer-fool-char ?f
-  "Char used to indicate a channel which had fool traffic lately (hidden)."
+  "Char indicating a channel which had fool traffic lately (hidden)."
   :type 'character)
 (defcustom erc-ibuffer-dangerous-host-char ?d
-  "Char used to indicate a channel which had dangerous-host traffic lately
-\(hidden)."
+  "Char indicating a channel which had dangerous-host traffic lately (hidden)."
   :type 'character)
 
 (define-ibuffer-filter erc-server
diff --git a/lisp/erc/erc-match.el b/lisp/erc/erc-match.el
index 43fbca3e666..fb50e84f655 100644
--- a/lisp/erc/erc-match.el
+++ b/lisp/erc/erc-match.el
@@ -24,7 +24,7 @@
 
 ;;; Commentary:
 
-;; This file includes stuff to work with pattern matching in ERC. If
+;; This file includes stuff to work with pattern matching in ERC.  If
 ;; you were used to customizing erc-fools, erc-keywords, erc-pals,
 ;; erc-dangerous-hosts and the like, this file contains these
 ;; customizable variables.
diff --git a/lisp/erc/erc-netsplit.el b/lisp/erc/erc-netsplit.el
index 9cfb947003c..994f2d07c30 100644
--- a/lisp/erc/erc-netsplit.el
+++ b/lisp/erc/erc-netsplit.el
@@ -52,7 +52,7 @@ netsplits, so that it can filter the JOIN messages on a netjoin too."
    (remove-hook 'erc-timer-hook #'erc-netsplit-timer)))
 
 (defcustom erc-netsplit-show-server-mode-changes-flag nil
-  "Set to t to enable display of server mode changes."
+  "Non-nil means to enable display of server mode changes."
   :type 'boolean)
 
 (defcustom erc-netsplit-debug nil
@@ -61,8 +61,7 @@ netsplits, so that it can filter the JOIN messages on a netjoin too."
 
 (defcustom erc-netsplit-regexp
   "^[^ @!\"\n]+\\.[^ @!\n]+ [^ @!\n]+\\.[^ @!\"\n]+$"
-  "This regular expression should match quit reasons produced
-by netsplits."
+  "This regular expression should match quit reasons produced by netsplits."
   :type 'regexp)
 
 (defcustom erc-netsplit-hook nil
diff --git a/lisp/erc/erc-networks.el b/lisp/erc/erc-networks.el
index ca0e90e984e..1c7742afd21 100644
--- a/lisp/erc/erc-networks.el
+++ b/lisp/erc/erc-networks.el
@@ -45,7 +45,7 @@
 ;; Variables
 
 (defgroup erc-networks nil
-  "IRC Networks"
+  "IRC Networks."
   :group 'erc)
 
 (defcustom erc-server-alist
@@ -720,7 +720,7 @@ NET is a symbol naming that IRC network and
 MATCHER is used to find a corresponding network to a server while
   connected to it.  If it is regexp, it's used to match against
   `erc-server-announced-name'.  It can also be a function (predicate).
-  Then it is executed with the server buffer as current-buffer."
+  Then it is executed with the server buffer as current buffer."
   :type '(repeat
 	  (list :tag "Network"
 		(symbol :tag "Network name")
diff --git a/lisp/erc/erc-pcomplete.el b/lisp/erc/erc-pcomplete.el
index 8ea37c7f290..43330755a85 100644
--- a/lisp/erc/erc-pcomplete.el
+++ b/lisp/erc/erc-pcomplete.el
@@ -44,7 +44,7 @@
 (require 'time-date)
 
 (defgroup erc-pcomplete nil
-  "Programmable completion for ERC"
+  "Programmable completion for ERC."
   :group 'erc)
 
 (defcustom erc-pcomplete-nick-postfix ":"
diff --git a/lisp/erc/erc-replace.el b/lisp/erc/erc-replace.el
index 3f69c4cb9cc..90c0ee6f8a4 100644
--- a/lisp/erc/erc-replace.el
+++ b/lisp/erc/erc-replace.el
@@ -37,7 +37,7 @@
 (require 'erc)
 
 (defgroup erc-replace nil
-  "Replace text from incoming messages"
+  "Replace text from incoming messages."
   :group 'erc)
 
 (defcustom erc-replace-alist nil
diff --git a/lisp/erc/erc-ring.el b/lisp/erc/erc-ring.el
index 666fd585926..52285a8343a 100644
--- a/lisp/erc/erc-ring.el
+++ b/lisp/erc/erc-ring.el
@@ -79,7 +79,7 @@ STATE-OR-STRING should be a string or an erc-input object."
   (setq erc-input-ring-index nil))
 
 (defun erc-clear-input-ring ()
-  "Remove all entries from the input ring, then call garbage-collect.
+  "Remove all entries from the input ring, then call `garbage-collect'.
 You might use this for security purposes if you have typed a command
 containing a password."
   (interactive)
diff --git a/lisp/erc/erc-sound.el b/lisp/erc/erc-sound.el
index 92759d206a3..e835c45af88 100644
--- a/lisp/erc/erc-sound.el
+++ b/lisp/erc/erc-sound.el
@@ -128,8 +128,9 @@ See also `play-sound-file'."
     (erc-log (format "Playing sound file %S" filepath))))
 
 (defun erc-toggle-sound (&optional arg)
-  "Toggles playing sounds on and off.  With positive argument,
-  turns them on.  With any other argument turns sounds off."
+  "Toggles playing sounds on and off.
+With positive argument, turns them on.  With any other argument
+turns sounds off."
   (interactive "P")
   (cond ((and (numberp arg) (> arg 0))
 	 (setq erc-play-sound t))
diff --git a/lisp/erc/erc-spelling.el b/lisp/erc/erc-spelling.el
index 950a821e3c4..ddfaafb0483 100644
--- a/lisp/erc/erc-spelling.el
+++ b/lisp/erc/erc-spelling.el
@@ -24,7 +24,7 @@
 
 ;;; Commentary:
 
-;; This is an ERC module to enable flyspell mode in ERC buffers. This
+;; This is an ERC module to enable flyspell mode in ERC buffers.  This
 ;; ensures correct behavior of flyspell, and even sets up a
 ;; channel-local dictionary if so required.
 
diff --git a/lisp/erc/erc-status-sidebar.el b/lisp/erc/erc-status-sidebar.el
index a75a74bb6fd..a6ad856bfd7 100644
--- a/lisp/erc/erc-status-sidebar.el
+++ b/lisp/erc/erc-status-sidebar.el
@@ -274,7 +274,7 @@ to the `window-configuration-change-hook'."
       (apply #'window-preserve-size (selected-window) t t nil))))
 
 (define-derived-mode erc-status-sidebar-mode special-mode "ERC Sidebar"
-  "Major mode for ERC status sidebar"
+  "Major mode for ERC status sidebar."
   ;; Don't scroll the buffer horizontally, if a channel name is
   ;; obscured then the window can be resized.
   (setq-local auto-hscroll-mode nil)
diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el
index 2582a5039a6..eb2a9712ac1 100644
--- a/lisp/erc/erc-track.el
+++ b/lisp/erc/erc-track.el
@@ -546,8 +546,7 @@ keybindings will not do anything useful."
        (erc-track-minor-mode -1)))))
 
 (defcustom erc-track-when-inactive nil
-  "Enable channel tracking even for visible buffers, if you are
-inactive."
+  "Enable channel tracking even for visible buffers, if you are inactive."
   :type 'boolean
   :set (lambda (sym val)
 	 (if erc-track-mode
@@ -598,9 +597,10 @@ only consider active buffers visible.")
     (erc-modified-channels-update)))
 
 (defvar erc-modified-channels-update-inside nil
-  "Variable to prevent running `erc-modified-channels-update' multiple
-times.  Without it, you cannot debug `erc-modified-channels-display',
-because the debugger also causes changes to the window-configuration.")
+  "Variable to prevent running `erc-modified-channels-update' multiple times.
+Without it, you cannot debug `erc-modified-channels-display',
+because the debugger also causes changes to the
+window-configuration.")
 
 (defun erc-modified-channels-update (&rest _args)
   "This function updates the information in `erc-modified-channels-alist'
@@ -630,7 +630,7 @@ ARGS are ignored."
   "The face to use when mouse is over channel names in the mode line.")
 
 (defun erc-make-mode-line-buffer-name (string buffer &optional faces count)
-  "Returns a button that switches to BUFFER when clicked.
+  "Return a button that switches to BUFFER when clicked.
 STRING is the string in the button.  It is possibly suffixed with
 the number of unread messages, according to variables
 `erc-track-showcount' and `erc-track-showcount-string'.
diff --git a/lisp/erc/erc-truncate.el b/lisp/erc/erc-truncate.el
index ff33fbc5570..2c4002f0ee0 100644
--- a/lisp/erc/erc-truncate.el
+++ b/lisp/erc/erc-truncate.el
@@ -25,8 +25,8 @@
 ;;; Commentary:
 
 ;; This implements buffer truncation (and optional log file writing
-;; support for the Emacs IRC client. Use `erc-truncate-mode' to switch
-;; on. Use `erc-enable-logging' to enable logging of the stuff which
+;; support for the Emacs IRC client.  Use `erc-truncate-mode' to switch
+;; on.  Use `erc-enable-logging' to enable logging of the stuff which
 ;; is getting truncated.
 
 ;;; Code:
@@ -34,7 +34,7 @@
 (require 'erc)
 
 (defgroup erc-truncate nil
-  "Truncate buffers when they reach a certain size"
+  "Truncate buffers when they reach a certain size."
   :group 'erc)
 
 (defcustom erc-max-buffer-size 30000
diff --git a/lisp/erc/erc-xdcc.el b/lisp/erc/erc-xdcc.el
index e1b9f0de3a7..c17eb59da31 100644
--- a/lisp/erc/erc-xdcc.el
+++ b/lisp/erc/erc-xdcc.el
@@ -68,7 +68,7 @@ being evaluated and should return strings."
 
 ;;;###autoload
 (defun erc-xdcc-add-file (file)
-  "Add a file to `erc-xdcc-files'."
+  "Add FILE to `erc-xdcc-files'."
   (interactive "fFilename to add to XDCC: ")
   (if (file-exists-p file)
       (add-to-list 'erc-xdcc-files file)))
diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index 60168d42f94..d08796a78d8 100644
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -80,32 +80,32 @@
   :group 'applications)
 
 (defgroup erc-buffers nil
-  "Creating new ERC buffers"
+  "Creating new ERC buffers."
   :group 'erc)
 
 (defgroup erc-display nil
-  "Settings for how various things are displayed"
+  "Settings for how various things are displayed."
   :group 'erc)
 
 (defgroup erc-mode-line-and-header nil
-  "Displaying information in the mode-line and header"
+  "Displaying information in the mode-line and header."
   :group 'erc-display)
 
 (defgroup erc-ignore nil
-  "Ignoring certain messages"
+  "Ignoring certain messages."
   :group 'erc)
 
 (defgroup erc-lurker nil
-  "Hide specified message types sent by lurkers"
+  "Hide specified message types sent by lurkers."
   :version "24.3"
   :group 'erc-ignore)
 
 (defgroup erc-query nil
-  "Using separate buffers for private discussions"
+  "Using separate buffers for private discussions."
   :group 'erc)
 
 (defgroup erc-quit-and-part nil
-  "Quitting and parting channels"
+  "Quitting and parting channels."
   :group 'erc)
 
 (defgroup erc-paranoia nil
@@ -113,7 +113,7 @@
   :group 'erc)
 
 (defgroup erc-scripts nil
-  "Running scripts at startup and with /LOAD"
+  "Running scripts at startup and with /LOAD."
   :group 'erc)
 
 (require 'erc-backend)
@@ -280,9 +280,9 @@ indicate it has handled the input."
   :type 'hook)
 
 (defcustom erc-join-hook nil
-  "Hook run when we join a channel.  Hook functions are called
-without arguments, with the current buffer set to the buffer of
-the new channel.
+  "Hook run when we join a channel.
+Hook functions are called without arguments, with the current
+buffer set to the buffer of the new channel.
 
 See also `erc-server-JOIN-functions', `erc-part-hook'."
   :group 'erc-hooks
@@ -533,10 +533,10 @@ Removes all users in the current channel.  This is called by
               (erc-channel-user-voice (cdr cdata))))))))
 
 (defun erc-get-channel-user-list ()
-  "Return a list of users in the current channel.  Each element
-of the list is of the form (USER . CHANNEL-DATA), where USER is
-an erc-server-user struct, and CHANNEL-DATA is either nil or an
-erc-channel-user struct.
+  "Return a list of users in the current channel.
+Each element of the list is of the form (USER . CHANNEL-DATA),
+where USER is an erc-server-user struct, and CHANNEL-DATA is
+either nil or an erc-channel-user struct.
 
 See also: `erc-sort-channel-users-by-activity'."
   (let (users)
@@ -816,7 +816,7 @@ set if some hacker is trying to flood you away."
 
 (defcustom erc-system-name nil
   "Use this as the name of your system.
-If nil, ERC will call `system-name' to get this information."
+If nil, ERC will call function `system-name' to get this information."
   :group 'erc
   :type '(choice (const :tag "Default system name" nil)
                  string))
@@ -1487,8 +1487,8 @@ Defaults to the server buffer."
   "IRC port to use if it cannot be detected otherwise.")
 
 (defconst erc-default-port-tls 6697
-  "IRC port to use for encrypted connections if it cannot be
-  detected otherwise.")
+  "IRC port to use for encrypted connections if it cannot be \
+detected otherwise.")
 
 (defcustom erc-join-buffer 'buffer
   "Determines how to display a newly created IRC buffer.
@@ -3741,7 +3741,7 @@ the message given by REASON."
   (condition-case nil
       (erc :server server :nick (erc-current-nick))
     (error
-     (erc-error "Cannot find host %s." server)))
+     (erc-error "Cannot find host: `%s'" server)))
   t)
 (put 'erc-cmd-SERVER 'process-not-needed t)
 
@@ -4490,7 +4490,7 @@ also `erc-format-nick-function'."
       (propertize prefix 'font-lock-face 'erc-default-face))))
 
 (defun erc-echo-notice-in-default-buffer (s parsed buffer _sender)
-  "Echos a private notice in the default buffer, namely the
+  "Echo a private notice in the default buffer, namely the
 target buffer specified by BUFFER, or there is no target buffer,
 the server buffer.  This function is designed to be added to
 either `erc-echo-notice-hook' or `erc-echo-notice-always-hook',
@@ -4499,30 +4499,32 @@ and always returns t."
   t)
 
 (defun erc-echo-notice-in-target-buffer (s parsed buffer _sender)
-  "Echos a private notice in BUFFER, if BUFFER is non-nil.  This
-function is designed to be added to either `erc-echo-notice-hook'
-or `erc-echo-notice-always-hook', and returns non-nil if BUFFER
-is non-nil."
+  "Echo a private notice in BUFFER, if BUFFER is non-nil.
+This function is designed to be added to either
+`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
+returns non-nil if BUFFER is non-nil."
   (if buffer
       (progn (erc-display-message parsed nil buffer s) t)
     nil))
 
 (defun erc-echo-notice-in-minibuffer (s _parsed _buffer _sender)
-  "Echos a private notice in the minibuffer.  This function is
-designed to be added to either `erc-echo-notice-hook' or
-`erc-echo-notice-always-hook', and always returns t."
+  "Echo a private notice in the minibuffer.
+This function is designed to be added to either
+`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
+always returns t."
   (message "%s" (concat "NOTICE: " s))
   t)
 
 (defun erc-echo-notice-in-server-buffer (s parsed _buffer _sender)
-  "Echos a private notice in the server buffer.  This function is
-designed to be added to either `erc-echo-notice-hook' or
-`erc-echo-notice-always-hook', and always returns t."
+  "Echo a private notice in the server buffer.
+This function is designed to be added to either
+`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
+always returns t."
   (erc-display-message parsed nil nil s)
   t)
 
 (defun erc-echo-notice-in-active-non-server-buffer (s parsed _buffer _sender)
-  "Echos a private notice in the active buffer if the active
+  "Echo a private notice in the active buffer if the active
 buffer is not the server buffer.  This function is designed to be
 added to either `erc-echo-notice-hook' or
 `erc-echo-notice-always-hook', and returns non-nil if the active
@@ -4532,14 +4534,15 @@ buffer is not the server buffer."
     nil))
 
 (defun erc-echo-notice-in-active-buffer (s parsed _buffer _sender)
-  "Echos a private notice in the active buffer.  This function is
-designed to be added to either `erc-echo-notice-hook' or
-`erc-echo-notice-always-hook', and always returns t."
+  "Echo a private notice in the active buffer.
+This function is designed to be added to either
+`erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
+always returns t."
   (erc-display-message parsed nil 'active s)
   t)
 
 (defun erc-echo-notice-in-user-buffers (s parsed _buffer sender)
-  "Echos a private notice in all of the buffers for which SENDER
+  "Echo a private notice in all of the buffers for which SENDER
 is a member.  This function is designed to be added to either
 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
 returns non-nil if there is at least one buffer for which the
@@ -4553,7 +4556,7 @@ See also: `erc-echo-notice-in-first-user-buffer',
       nil)))
 
 (defun erc-echo-notice-in-user-and-target-buffers (s parsed buffer sender)
-  "Echos a private notice in BUFFER and in all of the buffers for
+  "Echo a private notice in BUFFER and in all of the buffers for
 which SENDER is a member.  This function is designed to be added
 to either `erc-echo-notice-hook' or
 `erc-echo-notice-always-hook', and returns non-nil if there is
@@ -4569,7 +4572,7 @@ See also: `erc-echo-notice-in-user-buffers',
       nil)))
 
 (defun erc-echo-notice-in-first-user-buffer (s parsed _buffer sender)
-  "Echos a private notice in one of the buffers for which SENDER
+  "Echo a private notice in one of the buffers for which SENDER
 is a member.  This function is designed to be added to either
 `erc-echo-notice-hook' or `erc-echo-notice-always-hook', and
 returns non-nil if there is at least one buffer for which the
@@ -5030,10 +5033,11 @@ See also: `erc-update-user'."
 
 (defun erc-update-user (user &optional new-nick
                              host login full-name info)
-  "Update user info for USER.  USER must be an erc-server-user
-struct.  Any of NEW-NICK, HOST, LOGIN, FULL-NAME, INFO which are
-non-nil and not equal to the existing values for USER are used to
-replace the stored values in USER.
+  "Update user info for USER.
+USER must be an erc-server-user struct.  Any of NEW-NICK, HOST,
+LOGIN, FULL-NAME, INFO which are non-nil and not equal to the
+existing values for USER are used to replace the stored values in
+USER.
 
 If, and only if, a change is made,
 `erc-channel-members-changed-hook' is run for each channel for
@@ -5570,9 +5574,9 @@ submitted line to be intentional."
   string insertp sendp)
 
 (defun erc-send-input (input)
-  "Treat INPUT as typed in by the user.  It is assumed that the input
-and the prompt is already deleted.
-This returns non-nil only if we actually send anything."
+  "Treat INPUT as typed in by the user.
+It is assumed that the input and the prompt is already deleted.
+Return non-nil only if we actually send anything."
   ;; Handle different kinds of inputs
   (cond
    ;; Ignore empty input