normalize comments per style standards

Author: Christopher M. Neill

ansible/roles/bash_aliases/templates/dot_bash_aliases.sh.j2

@@ -1,25 +1,18 @@
-# not really an alias
-function logtail() {
+# Follows the logfile for a given app_name interpolating the datetime string into the logpath (/var/log/runnable/YYYY/MM/DD/HH/<app_name>.log
 # Usage: logtail <app_name>
-    # Name of the app log you wish you view, eg: api, navi, docker-listener, swarm-manager
+function logtail() {
     local app_name="$1"
-    # string of the current year, month, day and hour in YYYY/MM/DD/HH format
     local datetime=`date +%Y/%m/%d/%H`
-    # location of application logs specified in ansible configuration
     local app_log_dir="{{ app_log_dir }}"
-    # concatenate this strings to derive the full log path
     local logfile="${app_log_dir}/${datetime}/${app_name}.log"
-    # follow logfile, format via bunyan
     tail -f ${logfile} | bunyan
 }
 
-function npmlog() {
+# Outputs contents of an npm start log for <app_name>, if it exists, into a pager for reading.
 # Usage: npmlog <app_name>
-    # Name of the app npm log you wish to view.
+function npmlog() {
     local app_name="$1"
-    # system log dir
     local app_log_dir="/var/log"
-    # npm log
     local logfile="${app_log_dir}/${app_name}.log"
     less ${logfile}
 }

ansible/roles/bash_aliases/templates/dot_bash_aliases_root.sh.j2

@@ -1,25 +1,18 @@
-# not really an alias
-function logtail() {
+# Follows the logfile for a given app_name interpolating the datetime string into the logpath (/var/log/runnable/YYYY/MM/DD/HH/<app_name>.log
 # Usage: logtail <app_name>
-    # Name of the app log you wish you view, eg: api, navi, docker-listener, swarm-manager
+function logtail() {
     local app_name="$1"
-    # string of the current year, month, day and hour in YYYY/MM/DD/HH format
     local datetime=`date +%Y/%m/%d/%H`
-    # location of application logs specified in ansible configuration
     local app_log_dir="{{ app_log_dir }}"
-    # concatenate this strings to derive the full log path
     local logfile="${app_log_dir}/${datetime}/${app_name}.log"
-    # follow logfile, format via bunyan
     tail -f ${logfile} | bunyan
 }
 
-function npmlog() {
+# Outputs contents of an npm start log for <app_name>, if it exists, into a pager for reading.
 # Usage: npmlog <app_name>
-    # Name of the app npm log you wish to view.
+function npmlog() {
     local app_name="$1"
-    # system log dir
     local app_log_dir="/var/log"
-    # npm log
     local logfile="${app_log_dir}/${app_name}.log"
     less ${logfile}
 }