Module documentation docstrings

1 files changed, 12 insertions, 0 deletions

diff --git a/utils.py b/utils.py
index 967ffa4..8f30add 100644
--- a/utils.py
+++ b/utils.py
@@ -6,6 +6,18 @@ import logging
 from django.conf import settings
 from django.shortcuts import render
 from troggle.core.models_caves import CaveDescription
+"""Oddball mixture of critical, superfluous and useful functions which should 
+be re-located more sensibly to other modules:
+
+ChaosMonkey(n) - used by survex import to regenerate some .3d files
+save_carefully() - core function that saves troggle objects in the database
+
+various HTML/wiki functions presumably for logbooks?
+
+Use unknown:
+weighted_choice(lst)
+randomLogbookSentence()
+"""
 
 def ChaosMonkey(n):
     # returns True once every n calls - randomly