diff --git a/catchup.el b/catchup.el
index aeb7509..b199ce8 100644
--- a/catchup.el
+++ b/catchup.el
@@ -24,9 +24,9 @@
;;; Commentary:
;; catchup.el provides `catchup', a command for fetching system
-;; stats or other information. Custom shell commands can be run
+;; stats or other information. Custom shell commands can be run
;; or a file can be read, and that information is then formatted
-;; and displayed in the minibuffer. The output style and look can
+;; and displayed in the minibuffer. The output style and look can
;; be customized with `catchup-spec' and `catchup-separator'.
;; TODO: add a memory statistic using `memory-info'
@@ -90,7 +90,7 @@ Only information in `catchup-spec' is displayed; see its documentation for
more information on configuring it.
A separator or divider to divide information can be provided with
-`catchup-separator'. This string is placed between every result."
+`catchup-separator'. This string is placed between every result."
(interactive)
(let
((final ""))
diff --git a/enotify.el b/enotify.el
index 9f1000e..3779a86 100644
--- a/enotify.el
+++ b/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 .
+;;; 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")))
diff --git a/erc-highlight-nicknames.el b/erc-highlight-nicknames.el
index 4b9f170..0f125fd 100644
--- a/erc-highlight-nicknames.el
+++ b/erc-highlight-nicknames.el
@@ -28,7 +28,7 @@
;;; Commentary:
;; This is a modified version of erc-highlight-nicknames.el from
-;; . It has been
+;; . It has been
;; extended to use the configured ERC colour palette, using the faces
;; with names beginning with `fg:erc-color-face'.
;;
@@ -36,7 +36,7 @@
;; for a list of these faces.
;; Originally authored by André Riemann in 2007 and updated from 2008-2014
-;; by Andy Stewart. ERC face support was added by Jeremy Baxter in 2023.
+;; by Andy Stewart. ERC face support was added by Jeremy Baxter in 2023.
;; To use erc-highlight-nicknames.el, put this in your init file:
;;
@@ -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)))
diff --git a/esv.el b/esv.el
index e8b16a7..2f49a8b 100644
--- a/esv.el
+++ b/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 ."
diff --git a/phobos.el b/phobos.el
index c19c2b7..0afdd6a 100644
--- a/phobos.el
+++ b/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
@@ -25,7 +25,7 @@
;;; Commentary:
;; phobos.el provides several functions for viewing Phobos documentation
-;; and documentation for other D libraries. These functions open the
+;; and documentation for other D libraries. These functions open the
;; documentation in a web browser, calling the process `phobos-browser'.
;; These functions are provided:
@@ -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)))
@@ -67,7 +68,7 @@ SYMBOL can be a module (e.g. std.sumtype), a submodule (e.g.
std.algorithm.searching), a function or type (e.g. std.stdio.File)
or any other symbol part of a standard module, such as object.Exception.
-Phobos is the standard library for the D programming language. For more
+Phobos is the standard library for the D programming language. For more
information on Phobos and the D programming language, see ."
(interactive "MModule or symbol: ")
(phobos--visit "%s/%s.html" phobos-root (string-replace "." "/" symbol)))
@@ -77,7 +78,7 @@ information on Phobos and the D programming language, see ."
"View the documentation on SYMBOL from the dub package PACKAGE.
PACKAGE is the name of a package listed on the code.dlang.org registry.
-For more information on SYMBOL, see the documentation for `phobos'. If
+For more information on SYMBOL, see the documentation for `phobos'. If
SYMBOL is not provided, the contents of PACKAGE is displayed instead.
Support for dub package documentation is provided by Adam Ruppe's