dotfm

commit d419c8688d64ff025a68c26771f893d7ada124f5
parent 182e63479f31554e53bda340f525962d06e8d6ab
Author: GeaRSiX <gearsix@tuta.io>
Date:   Sun, 26 Jul 2020 13:24:46 +0100

added doc header to dotfm_list

Diffstat:
M
src/dotfm.py
 | 
3
+++

1 file changed, 3 insertions(+), 0 deletions(-)
diff --git a/src/dotfm.py b/src/dotfm.py
@@ -237,6 +237,9 @@ def dotfm_edit(dotfile_alias):
         error_exit('could not find alias {} in installed.csv'.format(os.path.basename(dotfile)))
 
 def dotfm_list(dotfiles):
+    """ list specified dotfile aliases and install location (displays all if none are specified)
+        @param dotfiles = an array of dotfile aliases to list, if len == 0 then all will be printed
+    """
     LOGGER.info('listing dotfm files: {}'.format('all' if len(dotfiles) == 0 else dotfiles))
 
     found = False