Module documentation docstrings

1 files changed, 7 insertions, 0 deletions

diff --git a/logbooksdump.py b/logbooksdump.py
index 4fdcf0c..6877afd 100644
--- a/logbooksdump.py
+++ b/logbooksdump.py
@@ -3,6 +3,12 @@ import time
 import timeit
 
 import settings
+"""Two currently unused functions. To be re-engineered to produce a logbook file
+in canonical post-2010 Parseloghtmltxt() format after importing from one of the 
+older more artisanal formats which will then be retired. For example, 2003 used 
+a unique HTML format and we should regularise this and deprecate the unique parser
+code Parseloghtml03().
+"""
 os.environ['PYTHONPATH'] = settings.PYTHON_PATH
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'settings')
 
@@ -34,6 +40,7 @@ def import_auto_logbooks():
                 print((os.path.join(root, filename)))
                 parsers.logbooks.parseAutoLogBookEntry(os.path.join(root, filename))
 
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 #Temporary function until definitive source of data transfered.
 from django.template.defaultfilters import slugify
 from django.template import Context, loader