From cb7e471c905dc7914442a640699e5c3538ce132c Mon Sep 17 00:00:00 2001
From: Henrik Lissner <henrik@lissner.net>
Date: Sun, 29 Jul 2018 18:26:20 +0200
Subject: [PATCH] General reformatting & comment revision/cleanup

---
 core/core-editor.el           |  2 ++
 core/core-ui.el               | 10 ++--------
 modules/emacs/vc/config.el    |  2 +-
 modules/tools/magit/config.el |  3 ++-
 4 files changed, 7 insertions(+), 10 deletions(-)

diff --git a/core/core-editor.el b/core/core-editor.el
index a60e0322e..56aad80d3 100644
--- a/core/core-editor.el
+++ b/core/core-editor.el
@@ -224,6 +224,7 @@ savehist file."
 ;; Autoloaded Plugins
 ;;
 
+;; `command-log-mode'
 (setq command-log-mode-auto-show t
       command-log-mode-open-log-turns-on-mode t)
 
@@ -237,6 +238,7 @@ savehist file."
   (advice-add #'evil-escape :before #'doom*quit-expand-region)
   (advice-add #'doom/escape :before #'doom*quit-expand-region))
 
+;; A better *help* buffer
 (def-package! helpful
   :defer t
   :init
diff --git a/core/core-ui.el b/core/core-ui.el
index 7a1933a3d..8d5f6edf8 100644
--- a/core/core-ui.el
+++ b/core/core-ui.el
@@ -106,13 +106,8 @@ Also see `doom-exit-buffer-hook'.")
 
 (fset #'yes-or-no-p #'y-or-n-p) ; y/n instead of yes/no
 
-
-;;
-;; Shims
-;;
-
+;; doesn't exist in terminal Emacs; define it to prevent errors
 (unless (fboundp 'define-fringe-bitmap)
-  ;; doesn't exist in terminal Emacs; define it to prevent errors
   (defun define-fringe-bitmap (&rest _)))
 
 
@@ -234,7 +229,6 @@ Also see `doom-exit-buffer-hook'.")
         show-paren-when-point-inside-paren t)
   (show-paren-mode +1))
 
-;;; More reliable inter-window border
 ;; The native border "consumes" a pixel of the fringe on righter-most splits,
 ;; `window-divider' does not. Available since Emacs 25.1.
 (setq-default window-divider-default-places t
@@ -247,7 +241,7 @@ Also see `doom-exit-buffer-hook'.")
   (remove-hook 'kill-buffer-query-functions #'server-kill-buffer-query-function))
 (add-hook 'server-visit-hook #'server-remove-kill-buffer-hook)
 
-;; `whitespace-mode'
+;; `whitespace-mode' (built-in)
 (setq whitespace-line-column nil
       whitespace-style
       '(face indentation tabs tab-mark spaces space-mark newline newline-mark
diff --git a/modules/emacs/vc/config.el b/modules/emacs/vc/config.el
index 84b13d253..1150909a2 100644
--- a/modules/emacs/vc/config.el
+++ b/modules/emacs/vc/config.el
@@ -9,7 +9,7 @@
   (advice-add #'git-timemachine--show-minibuffer-details :override #'+vc*update-header-line)
 
   (after! evil
-    ;; Force evil to rehash keybindings for the current state
+    ;; rehash evil keybindings so they are recognized
     (add-hook 'git-timemachine-mode-hook #'evil-normalize-keymaps))
 
   (when (featurep! :tools magit)
diff --git a/modules/tools/magit/config.el b/modules/tools/magit/config.el
index c5b113381..747938673 100644
--- a/modules/tools/magit/config.el
+++ b/modules/tools/magit/config.el
@@ -7,7 +7,8 @@ be set before `magithub' (and `magit') is loaded.")
 (defvar +magit-hub-features
   '(pull-request-merge commit-browse completion)
   "What features to initialize when `magithub' is loaded. Set this to `t' to
-load everything.")
+load everything. See `magithub-feature-list' to see what features are
+available.")
 
 
 ;;