Add docstrings

diff --git a/bin/daily b/bin/daily
index 2df8a9c49c048e9631aab0465cdbe2cc278912e4..b685ead3a440451684a9a7296888facb47ca58f4 100755 (executable)
--- a/bin/daily
+++ b/bin/daily
@@ -1,4 +1,7 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# daily - Opens ~/Journal/YYYY/MM-daily.md
+# Used for tracking day-to-day updates to efforts
+# One file per month

 year=`date +%Y`
 topic='daily'
 mkdir -p "$HOME/Journal/$year"
 year=`date +%Y`
 topic='daily'
 mkdir -p "$HOME/Journal/$year"

diff --git a/bin/mh b/bin/mh
index 18f19c4a3815db244d3c343d0a39b78db071c8fd..f24e21ece0e073c515fc45717189d4af3c613d3f 100755 (executable)
--- a/bin/mh
+++ b/bin/mh
@@ -1,4 +1,5 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# mh - Minion Help

 echo "Usage:"
 echo ""
 echo "mn - minion new - edit a new file with the year and month in the name"
 echo "Usage:"
 echo ""
 echo "mn - minion new - edit a new file with the year and month in the name"

diff --git a/bin/ml b/bin/ml
index b622021e1bdecfb0f0012158a1b35d3198afa204..2c9e6c9a3a7ec08022b3d9bb9a818591339f6a62 100755 (executable)
--- a/bin/ml
+++ b/bin/ml
@@ -1,3 +1,5 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# ml - minion list
+# Finds files in ~/Journal/YYYY whose names match the input

 year=`date +%Y`
 find $HOME/Journal/$year -type f -iname "*$1*\.md"
 year=`date +%Y`
 find $HOME/Journal/$year -type f -iname "*$1*\.md"

diff --git a/bin/mla b/bin/mla
index 95f115d64c90ed0d06698183ac2c8ee1bf040f39..95eb0a4f89105e12c964b1eeef9bbd741bbdea95 100755 (executable)
--- a/bin/mla
+++ b/bin/mla
@@ -1,2 +1,4 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# ml - minion list any
+# Finds files in ~/Journal/ (any year) whose names match the input

 find $HOME/Journal -type f -iname "*$1*\.md"
 find $HOME/Journal -type f -iname "*$1*\.md"

diff --git a/bin/mn b/bin/mn
index 9f2020ddcd513fb0f589f7c2a54a77621d1fb8dd..56ecba6de0ef4e83fdf215d52303590f7dc9645f 100755 (executable)
--- a/bin/mn
+++ b/bin/mn
@@ -1,4 +1,7 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# mn - minion new
+# Opens ~/Journal/YYYY/MM-your-input-here.md
+# in your $EDITOR

 year=`date +%Y`
 input=$@
 topic=${input// /-}
 year=`date +%Y`
 input=$@
 topic=${input// /-}

diff --git a/bin/mo b/bin/mo
index 568dd3a7c0db1275d80f388412bc682f237a44f1..70bd57145902f42337021020a82b4a1b7e6ec602 100755 (executable)
--- a/bin/mo
+++ b/bin/mo
@@ -1,4 +1,6 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# mo - minion open
+# Like `ml / minion list`, but opens all matches in your $EDITOR

 year=`date +%Y`
 files=$(find $HOME/Journal/$year -type f -iname "*$1*\.md")
 if [ -z ${EDITOR} ]; then
 year=`date +%Y`
 files=$(find $HOME/Journal/$year -type f -iname "*$1*\.md")
 if [ -z ${EDITOR} ]; then

diff --git a/bin/moa b/bin/moa
index 0978a65d3a37bb062186e5abafdfc13880d384f5..38fa4ce75ef2c86e576441ea52ce7506140b99f0 100755 (executable)
--- a/bin/moa
+++ b/bin/moa
@@ -1,4 +1,6 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# moa - minion open any
+# Like `mla / minion list any`, but opens all matches in your $EDITOR

 files=$(find $HOME/Journal -type f -iname "*$1*\.md")
 if [ -z ${EDITOR} ]; then
        echo "EDITOR unset, defaulting to Nano"
 files=$(find $HOME/Journal -type f -iname "*$1*\.md")
 if [ -z ${EDITOR} ]; then
        echo "EDITOR unset, defaulting to Nano"

diff --git a/bin/mp b/bin/mp
index dd6d9b51db21be9ad174eac0303139866234cb63..39056c9e4af3fa3f37c5667608ecca0759faf075 100755 (executable)
--- a/bin/mp
+++ b/bin/mp
@@ -1,4 +1,9 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# mp - minion print
+# Like `ml / minion list`, but gets the markdown file ready to print
+# Will act on a maximum of four files.
+# Creates .md.html files.
+# Opends files in your $BROWSER or assumes firefox

 year=`date +%Y`
 files=$(find $HOME/Journal/$year -type f -iname "*$1*\.md")
 
 year=`date +%Y`
 files=$(find $HOME/Journal/$year -type f -iname "*$1*\.md")
 

diff --git a/bin/ms b/bin/ms
index e969043fd22828affe63caa2399bdcc35f445874..5b7e47719370d7ad60a1b5c80dd456df57ee1808 100755 (executable)
--- a/bin/ms
+++ b/bin/ms
@@ -1,3 +1,5 @@
 #!/usr/bin/bash
 #!/usr/bin/bash

+# ms - minion spellcheck
+# Runs `aspell` on files returned by `ml / minion list`

 files=$(ml $1)
 aspell check $files
 files=$(ml $1)
 aspell check $files