Docstrings for all modules

parsers/QMs.py

@@ -9,6 +9,7 @@ from troggle.core.models.troggle import DataIssue
 from troggle.core.models.caves import QM, Cave, LogbookEntry
 from troggle.core.utils import save_carefully
 
+'''Reads the CSV files containg QMs for a select few caves'''
 
 def deleteQMs():
     QM.objects.all().delete()

parsers/imports.py

@@ -15,6 +15,9 @@ import troggle.parsers.surveys
 import troggle.parsers.logbooks
 import troggle.parsers.QMs
 
+'''Master data importUsed only by databaseReset.py currently
+'''
+
 def import_caves():
     print("-- Importing Caves to ",end="")
     print(django.db.connections.databases['default']['NAME'])

parsers/logbooks.py

@@ -15,10 +15,12 @@ from troggle.core.utils import TROG, save_carefully
 from troggle.core.models.caves import Cave, LogbookEntry, PersonTrip, GetCaveLookup
 from parsers.people import GetPersonExpeditionNameLookup
 
-# 
+'''
+Parses and imports logbooks in all their wonderful confusion
+
 # When we edit logbook entries, allow a "?" after any piece of data to say we've frigged it and
 # it can be checked up later from the hard-copy if necessary; or it's not possible to determin (name, trip place, etc)
-#
+'''
 
 #
 # the logbook loading section

parsers/survex.py

@@ -20,6 +20,10 @@ from troggle.core.views.caves import MapLocations
 from troggle.core.models.troggle import DataIssue, Expedition
 from troggle.core.models.survex import SurvexPersonRole, ScansFolder, SurvexDirectory, SurvexFile, SurvexBlock, SurvexStation
 
+'''Imports the tree of survex files following form a defined root .svx file
+It does also NOT scan the Loser repo for all the svx files - though it should !
+'''
+
 survexblockroot = None
 ROOTBLOCK = "rootblock"
 METRESINFEET = 3.28084

parsers/surveys.py

@@ -15,6 +15,10 @@ from troggle.core.models.survex import SingleScan, ScansFolder, TunnelFile
 from troggle.core.models.troggle import DataIssue
 from troggle.core.utils import save_carefully
 
+'''Scans through all the :drawings: repository looking
+for tunnel and therion files
+'''
+
 
 def get_or_create_placeholder(year):
     """ All surveys must be related to a logbookentry. We don't have a way to