From edd5a3efd901df68243372f46087d96d4fbf7715 Mon Sep 17 00:00:00 2001 From: Philip Sargent Date: Sat, 18 Jul 2020 16:23:54 +0100 Subject: Module documentation docstrings --- utils.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'utils.py') 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 -- cgit v1.2.3