nit: minor reformatting & revision

Also corrects the version string of obsolete variable `+mu4e-backend`.

bin/doom

@@ -164,7 +164,7 @@ EXIT CODES:
   5        Invalid, missing, or extra options/arguments
   6-15     Reserved for Doom
   16-192   Reserved for the user's extensions
-  254      Successful run (but then execute `doom-cli-restart-script')
+  254      Successful run (then execute the dynamically generated after-script)
   255      Uncaught critical errors
 
 SEE ALSO:

lisp/doom-cli-lib.el

@@ -1877,7 +1877,6 @@ errors to `doom-cli-error-file')."
     (error "Cannot nest `run!' calls"))
   (doom-run-hooks 'doom-after-init-hook)
   (doom-context-with 'cli
-    ;; (doom-modules-initialize)
     (let* ((args (flatten-list args))
            (context (make-doom-cli-context :prefix prefix :whole args))
            (doom-cli--context context)

lisp/doom-modules.el

@@ -50,7 +50,7 @@ NOT IMPLEMENTED YET. This file contains a module's metadata: their version,
 maintainers, checks, features, submodules, debug information, etc. And are used
 to locate modules in the user's file tree.")
 
-;; DEPRECATED: Module warnings will be rewritten in v3, and this variable will no longer be needed.
+;; DEPRECATED: Remove in v3, as it will be handled in the CLI
 (make-obsolete-variable 'doom-obsolete-modules nil "3.0.0")
 (defconst doom-obsolete-modules
   '((:feature (version-control  (:emacs vc) (:ui vc-gutter))

lisp/doom-start.el

@@ -339,9 +339,8 @@ If RETURN-P, return the message as a string instead of displaying it."
 ;; TODO: Catch errors
 (load! (string-remove-suffix ".el" doom-module-init-file) doom-user-dir t)
 
-;;; Load the rest of $DOOMDIR + modules if noninteractive
 ;; If the user is loading this file from a batch script, let's assume they want
-;; to load their userland config as well.
+;; to load their userland config immediately.
 (when noninteractive
   (doom-require 'doom-profiles)
   (let ((init-file (doom-profile-init-file)))
@@ -353,6 +352,7 @@ If RETURN-P, return the message as a string instead of displaying it."
       (doom-load init-file 'noerror)
       (doom-initialize-packages))))
 
+
 ;;; Entry point
 ;; HACK: This advice hijacks Emacs' initfile loader to accomplish the following:
 ;;

lisp/doom-ui.el

@@ -1,6 +1,6 @@
 ;;; doom-ui.el --- defaults for Doom's aesthetics -*- lexical-binding: t; -*-
 ;;; Commentary:
-;;; Code;
+;;; Code:
 
 ;;
 ;;; Variables

lisp/doom.el

@@ -54,7 +54,8 @@
 ;;   - hook: `window-setup-hook'
 ;;   - hook: `doom-init-ui-hook'
 ;;   - hook: `doom-after-init-hook'
-;;   > After startup is complete:
+;;   > After startup is complete (if file(s) have been opened from the command
+;;     line, these will trigger much earlier):
 ;;     - On first input:              `doom-first-input-hook'
 ;;     - On first switched-to buffer: `doom-first-buffer-hook'
 ;;     - On first opened file:        `doom-first-file-hook'
@@ -374,13 +375,13 @@ users).")
   (let ((old-value (default-toplevel-value 'file-name-handler-alist)))
     (set-default-toplevel-value
      'file-name-handler-alist
-     ;; HACK: The libraries bundled with Emacs can either be compiled,
-     ;;   compressed, or neither. We use calc-loaddefs.el as a heuristic to
-     ;;   guess what state all these libraries are in. If they're compressed, we
-     ;;   need to leave the gzip file handler in `file-name-handler-alist' so
-     ;;   Emacs knows how to load them. If they're compiled or neither, we can
-     ;;   omit the gzip handler altogether (at least during startup) for a boost
-     ;;   in startup and package load time.
+     ;; HACK: The elisp libraries bundled with Emacs are either compressed or
+     ;;   not, never both. So if calc-loaddefs.el.gz exists, calc-loaddefs.el
+     ;;   won't, and vice versa. This heuristic is used to guess the state of
+     ;;   all other built-in (or site); if they're compressed, we must leave the
+     ;;   gzip file handler in `file-name-handler-alist' so Emacs knows how to
+     ;;   load them. Otherwise, we can omit it (at least during startup) for a
+     ;;   boost in package load time.
      (if (eval-when-compile
            (locate-file-internal "calc-loaddefs.el" load-path))
          nil
@@ -767,7 +768,7 @@ appropriately against `noninteractive' or the `cli' context."
 ;;; Last minute initialization
 
 (when (daemonp)
-  (message "Starting Doom Emacs in daemon mode!")
+  (message "Starting Doom Emacs in daemon mode...")
   (unless doom-inhibit-log
     (add-hook! 'doom-after-init-hook :depth 106
       (unless doom-inhibit-log
@@ -788,8 +789,8 @@ appropriately against `noninteractive' or the `cli' context."
     (when (doom-context-push 'init)
       ;; HACK: Ensure OS checks are as fast as possible (given their ubiquity).
       (setq features (cons :system (delq :system features)))
-      ;; Remember these variables' initial values, so we can safely reset them at
-      ;; a later time, or consult them without fear of contamination.
+      ;; Remember these variables' initial values, so we can safely reset them
+      ;; at a later time, or consult them without fear of contamination.
       (dolist (var '(exec-path load-path process-environment))
         (put var 'initial-value (default-toplevel-value var))))))
 

modules/completion/company/README.org

@@ -22,7 +22,7 @@ https://assets.doomemacs.org/completion/company/overlay.png
 
 ** Module flags
 - +childframe ::
-  Display completion candidates in a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Child-Frames.html][child frame]] rather than an overlay or
+  Display completion candidates in a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Child-Frames.html][childframe]] rather than an overlay or
   tooltip. *Requires GUI Emacs.*
 - +tng ::
   Invoke completion on [[kbd:][TAB]] instad of [[kbd:][C-SPC]]. When company is active, [[kbd:][TAB]] and

modules/config/literate/autoload.el

@@ -181,8 +181,8 @@ This is performed with an asyncronous Emacs process, except when
 (defun +literate-recompile-maybe-h ()
   "Recompile literate config to `doom-user-dir'.
 
-We assume any org file in `doom-user-dir' is connected to your literate
-config, and should trigger a recompile if changed."
+We assume any org file in `doom-user-dir' is connected to your literate config,
+and should trigger a recompile if changed."
   (and (file-in-directory-p
         (buffer-file-name (buffer-base-buffer))
         (file-name-directory (file-truename +literate-config-file)))

modules/editor/evil/config.el

@@ -369,8 +369,7 @@ directives. By default, this only recognizes C directives.")
 ;;
 ;;; Keybinds
 
-;; Keybinds that have no Emacs+evil analogues (i.e. don't exist):
-;;   zu{q,w} - undo last marking
+;; TODO: zu{q,w} - undo last marking
 
 (map! :v  "@"     #'+evil:apply-macro
       :m  [C-i]   #'evil-jump-forward
@@ -530,6 +529,7 @@ directives. By default, this only recognizes C directives.")
       ;; evil-easymotion
       (:after evil-easymotion
        :m "gs" evilem-map
+       ;; TODO: Use named functions
        (:map evilem-map
         "a" (evilem-create #'evil-forward-arg)
         "A" (evilem-create #'evil-backward-arg)

modules/email/mu4e/config.el

@@ -2,7 +2,7 @@
 
 (defvar +mu4e-backend 'mbsync
   "Which backend to use. Can either be offlineimap, mbsync or nil (manual).")
-(make-obsolete-variable '+mu4e-backend "Use the :email mu4e module's +mbsync or +offlineimap flags instead" "3.0.0")
+(make-obsolete-variable '+mu4e-backend "Use the :email mu4e module's +mbsync or +offlineimap flags instead" "24.09")
 
 (defvar +mu4e-personal-addresses 'nil
   "Alternative to mu4e-personal-addresses that can be set for each account (mu4e context).")

modules/source.el

@@ -1,7 +0,0 @@
-;; This file supplies some metadata about this module repo to Doom's module
-;; manager. None of them are required, but it's a good idea to include them so
-;; Doom can perform some sanity checks for you.
-
-:root     "./"     ; where the module tree starts
-:version  "21.12"  ; version of this repo
-:requires "3.0.0"  ; minimum supported version of Doom's core

modules/ui/indent-guides/config.el

@@ -45,6 +45,8 @@ be enabled. If any function returns non-nil, the mode will not be activated."
   ;; TODO: Uncomment once we support treesit
   ;; (setq indent-bars-treesit-support (modulep! :tools tree-sitter))
 
+  ;; indent-bars adds this to `enable-theme-functions', which was introduced in
+  ;; 29.1, which will be redundant with `doom-load-theme-hook'.
   (unless (boundp 'enable-theme-functions)
     (add-hook 'doom-load-theme-hook #'indent-bars-reset-styles))
 

modules/ui/indent-guides/packages.el

@@ -3,4 +3,4 @@
 
 (package! indent-bars
   :recipe (:host github :repo "jdtsmith/indent-bars")
-   :pin "c8376cf4373a6444ca88e88736db7576dedb51d6")
+  :pin "c8376cf4373a6444ca88e88736db7576dedb51d6")