Fix typos and reword docstrings

core/core-ui.el

@@ -4,7 +4,7 @@
 ;;; Variables
 
 (defvar doom-init-theme-p nil
-  "If non-nil, a theme as been loaded.")
+  "If non-nil, a theme has been loaded.")
 
 (defvar doom-theme nil
   "A symbol representing the Emacs theme to load at startup.
@@ -13,9 +13,7 @@ This is changed by `load-theme'.")
 
 (defvar doom-font nil
   "The default font to use.
-
-Expects either a `font-spec', font object, an XFT font string or an XLFD font
-string.
+Must be a `font-spec', a font object, an XFT font string, or an XLFD string.
 
 This affects the `default' and `fixed-pitch' faces.
 
@@ -24,38 +22,33 @@ Examples:
   (setq doom-font \"Terminus (TTF):pixelsize=12:antialias=off\")")
 
 (defvar doom-variable-pitch-font nil
-  "The font to use for variable-pitch text.
-
-Expects either a `font-spec', font object, a XFT font string or XLFD string. See
+  "The default font to use for variable-pitch text.
+Must be a `font-spec', a font object, an XFT font string, or an XLFD string. See
 `doom-font' for examples.
 
-It is recommended you don't set specify a font-size, as to inherit `doom-font's
-size.")
+An omitted font size means to inherit `doom-font''s size.")
 
 (defvar doom-serif-font nil
   "The default font to use for the `fixed-pitch-serif' face.
-
-Expects either a `font-spec', font object, a XFT font string or XLFD string. See
+Must be a `font-spec', a font object, an XFT font string, or an XLFD string. See
 `doom-font' for examples.
 
-It is recommended you don't set specify a font-size, as to inherit `doom-font's
-size.")
+An omitted font size means to inherit `doom-font''s size.")
 
 (defvar doom-unicode-font
   (if IS-MAC
       (font-spec :family "Apple Color Emoji")
     (font-spec :family "Symbola"))
-  "Fallback font for unicode glyphs.
+  "Fallback font for Unicode glyphs.
+Must be a `font-spec', a font object, an XFT font string, or an XLFD string. See
+`doom-font' for examples.
 
-It defaults to Apple Color Emoji on MacOS and Symbola on Linux. Expects either a
-`font-spec', font object, a XFT font string or XLFD string. See `doom-font' for
-examples.
+The defaults on macOS and Linux are Apple Color Emoji and Symbola, respectively.
 
-It is recommended you don't set specify a font-size, as to inherit `doom-font's
-size.")
+An omitted font size means to inherit `doom-font''s size.")
 
 (defvar doom-unicode-extra-fonts nil
-  "Fonts to inject into the unicode charset before `doom-unicode-font'.")
+  "Fonts to inject into the Unicode charset before `doom-unicode-font'.")
 
 
 ;;
@@ -139,13 +132,12 @@ size.")
   (not (eq (current-buffer) (doom-fallback-buffer))))
 
 (defun doom-highlight-non-default-indentation-h ()
-  "Highlight whitespace that doesn't match your `indent-tabs-mode' setting.
+  "Highlight whitespace at odds with `indent-tabs-mode'.
+That is, highlight tabs if the usual indentation is with spaces, and highlight
+spaces at the beginnings of lines if the usual indentation is with tabs.
 
-e.g. If you indent with spaces by default, tabs will be highlighted. If you
-indent with tabs, spaces at BOL are highlighted.
-
-Does nothing if `whitespace-mode' or 'global-whitespace-mode' is already 
-active or if the current buffer is read-only or not file-visiting."
+Does nothing if `whitespace-mode' or `global-whitespace-mode' is already active
+or if the current buffer is read-only or not file-visiting."
   (unless (or (eq major-mode 'fundamental-mode)
               buffer-read-only
               (bound-and-true-p global-whitespace-mode)

init.example.el

@@ -40,7 +40,7 @@
        ophints           ; highlight the region an operation acts on
        (popup +defaults)   ; tame sudden yet inevitable temporary windows
        ;;pretty-code       ; ligatures or substitute text with pretty symbols
-       ;;tabs              ; an tab bar for Emacs
+       ;;tabs              ; a tab bar for Emacs
        ;;treemacs          ; a project drawer, like neotree but cooler
        ;;unicode           ; extended unicode support for various languages
        vc-gutter         ; vcs diff in the fringe

modules/tools/lookup/autoload/online.el

@@ -16,24 +16,23 @@
 
 ;;;###autoload
 (defun +lookup-online-backend-fn (identifier)
-  "Opens the browser and searches for IDENTIFIER online.
-
-Will prompt for which search engine to use the first time (or if the universal
-argument is non-nil)."
+  "Open the browser and search for IDENTIFIER online.
+When called for the first time, or with a non-nil prefix argument, prompt for
+the search engine to use."
   (+lookup/online
    identifier
    (+lookup--online-provider (not current-prefix-arg))))
 
 ;;;###autoload
 (defun +lookup/online (query provider)
-  "Looks up QUERY (a string) in you browser usin PROVIDER.
+  "Look up QUERY in the browser using PROVIDER.
+When called interactively, prompt for a query and, when called for the first
+time, the provider from `+lookup-provider-url-alist'. In subsequent calls, reuse
+the previous provider. With a non-nil prefix argument, always prompt for the
+provider.
 
-PROVIDER should be a key of `+lookup-provider-url-alist'.
-
-When used interactively, it will prompt for a query and, for the first time, the
-provider from `+lookup-provider-url-alist'. On consecutive uses, the last
-provider will be reused. If the universal argument is supplied, always prompt
-for the provider."
+QUERY must be a string, and PROVIDER must be a key of
+`+lookup-provider-url-alist'."
   (interactive
    (list (if (use-region-p) (doom-thing-at-point-or-region))
          (+lookup--online-provider current-prefix-arg)))
@@ -64,7 +63,7 @@ for the provider."
 
 ;;;###autoload
 (defun +lookup/online-select ()
-  "Runs `+lookup/online', but always prompts for the provider to use."
+  "Run `+lookup/online', but always prompt for the provider to use."
   (interactive)
   (let ((current-prefix-arg t))
     (call-interactively #'+lookup/online)))
@@ -77,7 +76,7 @@ for the provider."
 (defvar counsel-search-engine)
 ;;;###autoload
 (defun +lookup--online-backend-google (query)
-  "Search google, starting with QUERY, with live autocompletion."
+  "Search Google, starting with QUERY, with live autocompletion."
   (cond ((fboundp 'counsel-search)
          (let ((ivy-initial-inputs-alist `((t . ,query)))
                (counsel-search-engine 'google))
@@ -91,7 +90,7 @@ for the provider."
 
 ;;;###autoload
 (defun +lookup--online-backend-duckduckgo (query)
-  "Search duckduckgo, starting with QUERY, with live autocompletion."
+  "Search DuckDuckGo, starting with QUERY, with live autocompletion."
   (cond ((fboundp 'counsel-search)
          (let ((ivy-initial-inputs-alist `((t . ,query)))
                (counsel-search-engine 'ddg))

modules/ui/pretty-code/README.org

@@ -63,7 +63,7 @@ aren't working.
    or =+pragmata-pro=.
 2. Install the patched version of the associated font with ~M-x
    +pretty-code/install-patched-font~. Note: Pragmata Pro cannot be installed
-   this way because it isn't a non-free font and must be purchased and installed
+   this way because it is a non-free font and must be purchased and installed
    manually.
 
 * TODO Features