tree: checkdoc

enotify.el

@@ -22,14 +22,19 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with enotify.el.  If not, see <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
+;; enotify.el provides `enotify', a command for connecting to an IRC
+;; server, joining a channel, sending a message, and then leaving.
+
 ;;; Code:
 
 (defvar enotify-buffer "*enotify*"
-  "Name of the enotify process buffer")
+  "Name of the `enotify' process buffer.")
 (defvar enotify-proc "enotify-process"
-  "Name of the enotify socket process")
+  "Name of the `enotify' socket process.")
 (defvar enotify-realname "enotify-client"
-  "enotify's IRC realname that shows up in /whois")
+  "IRC realname for `enotify' that shows up in /whois.")
 
 (defun enotify-send-string (proc string)
   (process-send-string proc (concat string "\r\n")))

erc-highlight-nicknames.el

@@ -108,8 +108,7 @@
 
 (defface erc-highlight-nick-base-face
   '((t nil))
-  "Base face used for highlighting nicknames in ERC before the
-color is added."
+  "Face used for highlighting nicknames before color is added."
   :group 'erc-faces)
 
 (defvar erc-highlight-face-table
@@ -117,7 +116,7 @@ color is added."
   "Hash table containing unique ERC nickname faces.")
 
 (defun hexcolor-luminance (color)
-  "Returns the luminance of color COLOR. COLOR is a string \(e.g.
+  "Return the luminance of color COLOR.  COLOR is a string \(e.g.
 \"#ffaa00\", \"blue\"\) `color-values' accepts. Luminance is a
 value of 0.299 red + 0.587 green + 0.114 blue and is always
 between 0 and 255."
@@ -128,7 +127,7 @@ between 0 and 255."
     (floor (+ (* 0.299 r) (* 0.587 g) (* 0.114 b)) 256)))
 
 (defun invert-color (color)
-  "Returns the inverted color of COLOR."
+  "Return the inverted color of COLOR."
   (let* ((values (x-color-values color))
          (r (car values))
          (g (car (cdr values)))

esv.el

@@ -69,8 +69,8 @@
   (read-only-mode))
 
 (defun esv (passage)
-  "Fetch the Bible passage identified by BOOK and VERSES.
-The result will be redirected to a buffer named after the passage.
+  "Fetch the Bible passage identified by PASSAGE.
+The result will be redirected to a buffer named after PASSAGE.
 
 Requires the esv command line tool to be in the system's PATH.
 esv can be acquired at <https://sr.ht/~jeremy/esv>."

phobos.el

@@ -1,4 +1,4 @@
-;;; phobos.el --- view Phobos documentation from within Emacs  -*- lexical-binding:t -*-
+;;; phobos.el --- view Phobos documentation  -*- lexical-binding:t -*-
 
 ;; Copyright (C) 2024 Jeremy Baxter
 
@@ -55,6 +55,7 @@
   :type 'string)
 
 (defun phobos--visit (&rest format-args)
+  "Call `format' with FORMAT-ARGS and pass the result to a web browser."
   (let ((url (apply #'format format-args)))
     (shell-command (concat phobos-browser " " url))
     (message url)))