Browse Source

Add missing docstrings

Alois Mahdal 8 years ago
parent
commit
f51f9839ce
1 changed files with 9 additions and 0 deletions
  1. 9
    0
      src/shellfu/saturnin.sh

+ 9
- 0
src/shellfu/saturnin.sh View File

5
 shellfu import pretty
5
 shellfu import pretty
6
 
6
 
7
 saturnin__help() {
7
 saturnin__help() {
8
+    #
9
+    # Print simple help message (basically just list of commands)
10
+    #
8
     {
11
     {
9
         echo "built-in commands:"
12
         echo "built-in commands:"
10
         echo "    conf"
13
         echo "    conf"
18
 }
21
 }
19
 
22
 
20
 saturnin__lssc() {
23
 saturnin__lssc() {
24
+    #
25
+    # List subcommands
26
+    #
21
     find "$SATURNIN_LIBEXEC" \
27
     find "$SATURNIN_LIBEXEC" \
22
         -mindepth 1 \
28
         -mindepth 1 \
23
         -maxdepth 1 \
29
         -maxdepth 1 \
46
 }
52
 }
47
 
53
 
48
 saturnin__runsc() {
54
 saturnin__runsc() {
55
+    #
56
+    # Run subcommand $SATURNIN_SUBCOMMAND
57
+    #
49
     local lexpath
58
     local lexpath
50
     lexpath+="$SATURNIN_LIBEXEC/"
59
     lexpath+="$SATURNIN_LIBEXEC/"
51
     lexpath+="$SATURNIN_LIBEXEC_PREFIX$SATURNIN_SUBCOMMAND"
60
     lexpath+="$SATURNIN_LIBEXEC_PREFIX$SATURNIN_SUBCOMMAND"