Revise and update docstrings and comments

modules/lang/emacs-lisp/autoload.el

@@ -1,7 +1,7 @@
 ;;; lang/emacs-lisp/autoload.el -*- lexical-binding: t; -*-
 
 ;;
-;; Library
+;;; Library
 
 ;;;###autoload
 (defun +emacs-lisp-eval (beg end)
@@ -77,7 +77,7 @@ library/userland functions"
 
 
 ;;
-;; Commands
+;;; Commands
 
 ;;;###autoload
 (defun +emacs-lisp/open-repl ()
@@ -92,7 +92,7 @@ library/userland functions"
 
 
 ;;
-;; Hooks
+;;; Hooks
 
 ;;;###autoload
 (defun +emacs-lisp|extend-imenu ()

modules/lang/emacs-lisp/config.el

@@ -14,7 +14,7 @@ This marks a foldable marker for `outline-minor-mode' in elisp buffers.")
 
 
 ;;
-;; Config
+;;; Config
 
 (def-package! elisp-mode
   :mode ("\\.Cask\\'" . emacs-lisp-mode)
@@ -76,14 +76,13 @@ This marks a foldable marker for `outline-minor-mode' in elisp buffers.")
 
 
 ;;
-;; Packages
+;;; Packages
 
-;; `auto-compile'
+;;;###package auto-compile
 (setq auto-compile-display-buffer nil
       auto-compile-use-mode-line nil)
 
 
-;; `macrostep'
 (when (featurep! :editor evil)
   (after! macrostep
     (evil-define-key* 'normal macrostep-keymap
@@ -108,7 +107,7 @@ This marks a foldable marker for `outline-minor-mode' in elisp buffers.")
     (add-hook 'macrostep-mode-hook #'evil-normalize-keymaps)))
 
 
-;; `overseer'
+;;;###package overseer
 (autoload 'overseer-test "overseer" nil t)
 (remove-hook 'emacs-lisp-mode-hook 'overseer-enable-mode)
 
@@ -129,7 +128,7 @@ This marks a foldable marker for `outline-minor-mode' in elisp buffers.")
 
 
 ;;
-;; Project modes
+;;; Project modes
 
 (def-project-mode! +emacs-lisp-ert-mode
   :modes (emacs-lisp-mode)

modules/lang/web/+css.el

@@ -22,11 +22,12 @@
 
 
 ;;
-;; Major modes
+;;; Major modes
 
 (add-hook! (css-mode sass-mode stylus-mode) #'rainbow-mode)
 
-(after! css-mode  ; built-in -- contains both css-mode & scss-mode
+;; built-in, and contains both css-mode & scss-mode
+(after! css-mode
   ;; css-mode hooks apply to scss and less-css modes
   (add-hook 'css-mode-hook #'rainbow-delimiters-mode)
   (unless EMACS26+
@@ -41,7 +42,7 @@
 
 
 ;;
-;; Tools
+;;; Tools
 
 (when (featurep! +lsp)
   (add-hook! (css-mode sass-mode less-css-mode) #'lsp!))

modules/lang/web/autoload/css.el

@@ -45,8 +45,9 @@
 
 ;;;###autoload
 (defun +css/comment-indent-new-line ()
-  "Continues the comment in an indented new line in css-mode and scss-mode.
-Meant for `comment-line-break-function'."
+  "Continues the comment in an indented new line.
+
+Meant for `comment-line-break-function' in `css-mode' and `scss-mode'."
   (interactive)
   (when (sp-point-in-comment)
     (let ((at-end (looking-at-p ".+\\*/"))

modules/lang/web/autoload/evil.el

@@ -3,7 +3,7 @@
 
 ;;;###autoload (autoload '+web:encode-html-entities "lang/web/autoload/evil" nil t)
 (evil-define-operator +web:encode-html-entities (beg end &optional input)
-  "Encodes HTML entities in the selected region."
+  "Encodes HTML entities in INPUT or the selected region."
   (interactive "<r><a>")
   (cond (input
          (insert (+web-encode-entities input)))
@@ -12,7 +12,7 @@
 
 ;;;###autoload (autoload '+web:decode-html-entities "lang/web/autoload/evil" nil t)
 (evil-define-operator +web:decode-html-entities (beg end &optional input)
-  "Decodes HTML entities in the selected region."
+  "Decodes HTML entities in INPUT or the selected region."
   (interactive "<r><a>")
   (cond (input
          (insert (+web-decode-entities input)))

modules/lang/web/autoload/html.el

@@ -94,6 +94,10 @@ function @ http://ergoemacs.org/emacs/elisp_replace_html_entities_command.html"
   "TODO"
   (+web--entities-string text t))
 
+
+;;
+;;; Commands
+
 ;;;###autoload
 (defun +web/encode-entities-region (beg end)
   "Encode HTML entities in region."
@@ -108,8 +112,10 @@ function @ http://ergoemacs.org/emacs/elisp_replace_html_entities_command.html"
 
 ;;;###autoload
 (defun +web/indent-or-yas-or-emmet-expand ()
-  "Invoke `indent-for-tab-command' if at or before text bol, `yas-expand' if on
-a snippet, or `emmet-expand-yas'/`emmet-expand-line', depending on whether
+  "Do-what-I-mean on TAB.
+
+Invokes `indent-for-tab-command' if at or before text bol, `yas-expand' if on a
+snippet, or `emmet-expand-yas'/`emmet-expand-line', depending on whether
 `yas-minor-mode' is enabled or not."
   (interactive)
   (call-interactively