From 263837528d0bf14f8dc4ec7914ecfbfabe4a7ac9 Mon Sep 17 00:00:00 2001
From: David Florness <david@florness.com>
Date: Wed, 10 Jun 2020 14:44:17 -0600
Subject: [PATCH] Cleanup comments

---
 init.el            | 36 +++++++++++++++++-------------------
 lisp/appearance.el | 28 ++++++++++++++--------------
 lisp/dev.el        |  8 ++++----
 lisp/keys.el       | 18 +++++++++---------
 lisp/lisps.el      |  8 ++++----
 lisp/org.el        |  7 +++----
 6 files changed, 51 insertions(+), 54 deletions(-)

diff --git a/init.el b/init.el
index 3c82b27..75b239e 100644
--- a/init.el
+++ b/init.el
@@ -6,16 +6,14 @@
 
 ;;; Code:
 
-;;; Install local user packages
+;; Install local user packages
 (dolist (d (apply #'append (mapcar #'file-expand-wildcards
                                 '("~/.local/share/emacs/site-lisp/*"
                                   "/usr/local/share/emacs/site-lisp/*"
                                   "/usr/share/emacs/site-lisp/*"))))
   (add-to-list 'load-path d))
 
-;;; Loading of personal config files
-
-;; these config files have high priority
+;; Loading of personal config files.  The top two files have priority
 (load "~/.emacs.d/lisp/packages")
 (load "~/.emacs.d/lisp/keys")
 
@@ -32,9 +30,9 @@
 (load "~/.emacs.d/lisp/treemacs")
 (load "~/.emacs.d/lisp/web")
 
-;;; Winner mode: allows for undoing and redoing of windoow configurations
-;;; C-c <left> : undo
-;;; C-c <right>: redo
+;; Winner mode: allows for undoing and redoing of windoow configurations
+;; C-c <left> : undo
+;; C-c <right>: redo
 (winner-mode t)
 (dolist (m '(motion normal))
   (evil-global-set-key m (kbd "C-w u") #'winner-undo))
@@ -42,10 +40,10 @@
 (dolist (m '(motion normal insert))
   (evil-global-set-key m (kbd "C-x d") (lambda () (interactive) (dired "."))))
 
-;;; Allow easily switching windows with Shift-{left,right,up,down}
+;; Allow easily switching windows with Shift-{left,right,up,down}
 (windmove-default-keybindings)
 
-;;; don't show details of files in dired mode by default
+;; don't show details of files in dired mode by default
 (add-hook 'dired-mode-hook (lambda () (dired-hide-details-mode t)))
 
 (use-package fzf
@@ -75,20 +73,20 @@
          ("\\.markdown\\'" . markdown-mode))
   :custom (markdown-command "markdown"))
 
-;;; magit: a Git Porcelain
+;; magit: a Git Porcelain
 (use-package magit
   :bind
   (("C-x g" . magit-status)
    ("C-x M-g" . magit-dispatch)))
 
-;;; Syntax/error checking
+;; Syntax/error checking
 (use-package flycheck
   :config
   (global-flycheck-mode)
   (evil-define-key 'normal
     flycheck-error-list-mode-map (kbd "q") 'quit-window))
 
-;;; Yasnippet: yet another snippet extension
+;; Yasnippet: yet another snippet extension
 (use-package yasnippet
   :bind
   ("C-c y" . yas-expand)
@@ -98,7 +96,7 @@
 (use-package yasnippet-snippets
   :after yasnippet)
 
-;;; Setup duckduckgo search engine
+;; Setup duckduckgo search engine
 (use-package engine-mode
   :config
   (defengine duckduckgo
@@ -116,14 +114,14 @@
   :config
   (which-key-mode))
 
-;;; setup the mu4e email client
+;; setup the mu4e email client
 (when (file-exists-p "~/scripts/setup-mu4e.el")
   (load-file "~/scripts/setup-mu4e.el"))
 
-;;; statistics software and R-lang integration
+;; statistics software and R-lang integration
 (use-package ess)
 
-;;; TeX/LaTeX
+;; TeX/LaTeX
 (use-package tex
   :defer
   :straight auctex
@@ -134,10 +132,10 @@
   (setcdr (assoc 'output-pdf TeX-view-program-selection)
           '("Zathura")))
 
-;;; ability to insert random text
+;; ability to insert random text
 (use-package lorem-ipsum)
 
-;;; show eshell with C-S-s
+;; show eshell with C-S-s
 (use-package shell-pop
   :custom
   (shell-pop-shell-type '("eshell" "*eshell*" #'eshell))
@@ -149,7 +147,7 @@
 (use-package graphviz-dot-mode
   :defer t)
 
-;;; Start Emacs Daemon
+;; Start Emacs Daemon
 (require 'server)
 (unless (server-running-p)
   (server-start))
diff --git a/lisp/appearance.el b/lisp/appearance.el
index 63c8c16..fd34e1f 100644
--- a/lisp/appearance.el
+++ b/lisp/appearance.el
@@ -1,7 +1,7 @@
-;;; Change frame title
+;; Change frame title
 (setq frame-title-format "emacs")
 
-;;; Font
+;; Font
 (ignore-errors
   (set-frame-font
    (font-spec
@@ -14,25 +14,25 @@
 (set-language-environment "UTF-8")
 (prefer-coding-system 'utf-8)
 
-(menu-bar-mode 0) ; Disable menu bar
-(scroll-bar-mode 0) ; Disable scroll bar
-(tool-bar-mode 0) ; Disable tool bar
-(blink-cursor-mode 0) ; Turn off cursor blinking
-(setq visible-cursor nil) ; Turn off cursor blinking in terminals
-(column-number-mode 1) ; Show column number next to line number in mode line
-(show-paren-mode 1) ; Highlight parentheses
-(global-hi-lock-mode 1) ; Highlight stuff with M-s h
+(blink-cursor-mode 0)        ; Turn off cursor blinking
+(column-number-mode 1)       ; Show column number next to line number in mode line
+(global-hi-lock-mode 1)      ; Highlight stuff with M-s h
+(menu-bar-mode 0)            ; Disable menu bar
 (mouse-avoidance-mode 'none) ; Move mouse if it gets in the way of the cursor
+(scroll-bar-mode 0)          ; Disable scroll bar
+(setq visible-cursor nil)    ; Turn off cursor blinking in terminals
+(show-paren-mode 1)          ; Highlight parentheses
+(tool-bar-mode 0)            ; Disable tool bar
 
-;;; Spell check in comments and strings
+;; Spell check in comments and strings
 (flyspell-prog-mode)
 
-;;; Setup theme
+;; Setup theme
 (use-package gruvbox-theme
   :defer t)
 (load-theme 'gruvbox-dark-hard t)
 
-;;; Transparency control
+;; Transparency control
 (defvar new-frames-are-transparent t
   "Whether new frames should be transparent")
 
@@ -56,7 +56,7 @@
                (if new-frames-are-transparent
                    (set-frame-parameter frame 'alpha 80))))
 
-;;; display ugly ^L page breaks as tidy horizontal lines
+;; display ugly ^L page breaks as tidy horizontal lines
 (use-package page-break-lines
   :config
   (global-page-break-lines-mode))
diff --git a/lisp/dev.el b/lisp/dev.el
index 369bc24..81b3fa4 100644
--- a/lisp/dev.el
+++ b/lisp/dev.el
@@ -14,10 +14,10 @@
  ;; Non-nil means display source file contatining the main routine at startup
  gdb-show-main t)
 
-;;; Reload file's buffer when the file changes on disk
+;; Reload file's buffer when the file changes on disk
 (global-auto-revert-mode t)
 
-;;; Company (complete anything) mode
+;; Company (complete anything) mode
 (use-package company
   :hook
   (after-init . global-company-mode)
@@ -26,13 +26,13 @@
   (evil-global-set-key 'insert (kbd "C-SPC") #'company-complete)
   (define-key company-active-map (kbd "RET") 'company-complete-selection))
 
-;;; Quickhelp (documentation lookup) for company
+;; Quickhelp (documentation lookup) for company
 (use-package company-quickhelp
   :after company
   :config
   (company-quickhelp-mode 1))
 
-;;; company backend for C/C++ headers
+;; company backend for C/C++ headers
 (use-package company-c-headers
   :after company
   :config
diff --git a/lisp/keys.el b/lisp/keys.el
index a5b4f37..073e6fe 100644
--- a/lisp/keys.el
+++ b/lisp/keys.el
@@ -1,4 +1,4 @@
-;;; Evil (extensible vi layer)
+;; Evil (extensible vi layer)
 (use-package evil
   :custom
   (evil-want-C-u-scroll t)
@@ -23,23 +23,23 @@
 (setq scroll-step 1
       delete-selection-mode 1)
 
-;;; Evil-like bindings for various modes
+;; Evil-like bindings for various modes
 (use-package evil-collection
   :after evil
   :init
   (evil-collection-init))
 
-;;; Easily surround text
+;; Easily surround text
 (use-package evil-surround
   :after evil
   :config
   (global-evil-surround-mode 1))
 
-;;; Evil keybindings for magit
+;; Evil keybindings for magit
 (use-package evil-magit
   :after (evil magit))
 
-;;; Evil keybindings for org
+;; Evil keybindings for org
 (use-package evil-org
   :after (evil org)
   :hook (org-mode . evil-org-mode)
@@ -55,8 +55,8 @@
                    "*urxvt*"
                    "/usr/bin/urxvt"))) ;TODO: don't use absolute path
 
-;;; I don't always know where my frames are, and I want a way to kill
-;;; Emacs 100% of the time
+;; I don't always know where my frames are, and I want a way to kill Emacs 100%
+;; of the time
 (global-set-key (kbd "C-x C-c") 'save-buffers-kill-emacs)
 (global-set-key (kbd "<f9>") (lambda ()
                                (interactive)
@@ -66,7 +66,7 @@
                                 (interactive)
                                 (kill-buffer)))
 
-;;; a minor mode for dealing with pairs
+;; a minor mode for dealing with pairs
 (use-package smartparens
   :config
   (require 'smartparens-config)
@@ -84,7 +84,7 @@
         ("C-a"   . evil-numbers/inc-at-pt)
         ("C-S-a" . evil-numbers/dec-at-pt)))
 
-;;; Function keys
+;; Function keys
 (global-set-key (kbd "<f5>") (lambda ()
                                (interactive)
                                (setq-local compilation-read-command nil)
diff --git a/lisp/lisps.el b/lisp/lisps.el
index 936143c..0b69433 100644
--- a/lisp/lisps.el
+++ b/lisp/lisps.el
@@ -1,4 +1,4 @@
-;;; Emacs LISP ;;;
+;;; Emacs LISP
 
 (use-package elisp-slime-nav
   :after evil
@@ -18,7 +18,7 @@
   :hook
   (emacs-lisp-mode . auto-compile-mode))
 
-;;; Common LISP ;;;
+;;; Common LISP
 
 (use-package slime
   :custom
@@ -30,12 +30,12 @@
 (use-package common-lisp-snippets
   :after (yasnippet slime))
 
-;;; Racket ;;;
+;;; Racket
 
 (use-package racket-mode
   :defer t)
 
-;;; Clojure ;;;
+;;; Clojure
 
 (use-package cider
   :custom
diff --git a/lisp/org.el b/lisp/org.el
index 90805f3..c33b232 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -1,5 +1,4 @@
-;;; Org mode for keeping notes, todo lists, planning, and fast
-;;; documenting
+;;; Org mode for keeping notes, todo lists, planning, and fast documenting
 (use-package org
   :straight org-plus-contrib
   :custom
@@ -29,12 +28,12 @@
    ("C-c M-t r" . org-timer-stop) ; r for reset
    ("C-c M-t s" . org-timer-start)))
 
-;;; UTF-8 bullets for org-mode
+;; UTF-8 bullets
 (use-package org-bullets
   :after org
   :hook (org-mode . org-bullets-mode))
 
-;;; Keep personal contacts in org-mode file
+;; keep personal contacts in org-mode file
 (use-package org-contacts
   :straight nil
   :after org
-- 
2.38.4