misc: dfm tweaks, documentation, code style

config/alias

@@ -52,11 +52,16 @@ if [[ $(uname) == 'Darwin' ]]; then
   alias emptytrash="sudo rm -rfv /Volumes/*/.Trashes; sudo rm -rfv ~/.Trash; sudo rm -rfv /private/var/log/asl/*.asl"
 fi
 
-alias watchx='watch -dpbc' # watch with: differences, precise, beep and color
+# watch with: differences, precise, beep and color
+alias watchx='watch -dpbc'
+# delete .DS_Store files
 alias zapds='find . -name ".DS_Store" -print -delete'
-alias t='tail -f'   # tail with follow flag on
-alias dn='du -chd1' # directory usage, return only the total
-alias mirrorsite='wget -m -k -K -E -e robots=off' # Mirror site
+# tail with follow flag on
+alias t='tail -f'
+# directory usage, return only the total
+alias dn='du -chd1'
+# Mirror site with wget
+alias mirror_site='wget -m -k -K -E -e robots=off'
 # Mirror stdout to stderr, useful for seeing data going through a pipe
 alias peek='tee >(cat 1>&2)'
 

config/exports

@@ -41,4 +41,3 @@ source "$DOTFILES/config/exports-apps"
 if command -v nvim &> /dev/null; then
   export EDITOR="nvim"
 fi
-

config/functions

@@ -66,17 +66,23 @@ function silent
   "$@" >&/dev/null
 }
 
+# Remove directory from the PATH variable
+# usage: path_remove ~/.local/bin
 function path_remove
 {
   PATH=$(echo -n "$PATH" | awk -v RS=: -v ORS=: "\$0 != \"$1\"" | sed 's/:$//')
 }
 
+# Append directory to the PATH
+# usage: path_append ~/.local/bin
 function path_append
 {
   path_remove "$1"
   PATH="${PATH:+"$PATH:"}$1"
 }
 
+# Prepend directory to the PATH
+# usage: path_prepend ~/.local/bin
 function path_prepend
 {
   path_remove "$1"
@@ -108,4 +114,3 @@ function x-default-antigen-bundles
   hash python 2> /dev/null && antigen bundle MichaelAquilina/zsh-autoswitch-virtualenv
   hash rvm 2> /dev/null && antigen bundle unixorn/rvm-plugin
 }
-