General cleanup, refactor and documentation

modules/completion/ivy/config.el

@@ -1,5 +1,14 @@
 ;;; completion/ivy/packages.el
 
+;; Ivy is my completion backend of choice. With counsel's help, I get:
+;;
+;; + Project-wide search with `counsel-ag' (or `+ivy:ag-search')
+;; + Project-wide replace if you press <backtab> in the ag occur buffer.
+;; + An Atom/Sublime-Text Command-T implementation with `counsel-find-file' and
+;;   `counsel-projectile-find-file'.
+;; + Ido-like completion for a slew of functions, like `counsel-M-x' and
+;;   `counsel-imenu'.
+
 ;; TODO Make this a setting
 (defmacro @def-counsel-action (name &rest forms)
   `(defun ,(intern (format "+ivy/counsel-%s" (symbol-name name))) ()
@@ -68,6 +77,7 @@
 
   (require 'counsel-projectile)
 
+  ;; FIXME Messy workaround, refactor this
   (@def-counsel-action ag-open-in-other-window
     (lambda (x)
       (when (string-match "\\`\\(.*?\\):\\([0-9]+\\):\\(.*\\)\\'" x)

modules/feature/workspaces/autoload/workspaces.el

@@ -363,14 +363,17 @@ the workspace and move to the next."
 
 ;;;###autoload
 (defun +workspace-message (message &optional type)
+  "Show an 'elegant' message in the echo area next to a listing of workspaces."
   (message "%s" (+workspace--message-body message type)))
 
 ;;;###autoload
 (defun +workspace-error (message &optional noerror)
+  "Show an 'elegant' error in the echo area next to a listing of workspaces."
   (funcall (if noerror 'message 'error) "%s" (+workspace--message-body message 'error)))
 
 ;;;###autoload
 (defun +workspace/display ()
+  "Display a list of workspaces (like tabs) in the echo area."
   (interactive)
   (message "%s" (+workspace--tabline)))