More documentation per #83

mongonaut/forms/form_mixins.py

@@ -28,6 +28,7 @@
 
 
 def get_document_unicode(document):
+    """Safely converts MongoDB document strings to unicode."""
     try:
         return document.__unicode__()
     except AttributeError:

mongonaut/forms/forms.py

@@ -33,6 +33,7 @@ def __init__(self, form_post_data=None, *args, **kwargs):
         super(MongoModelForm, self).__init__(*args, **kwargs)
 
     def set_fields(self):
+        """Sets existing data to form fields."""
 
         # Get dictionary map of current model
         if self.is_initialized:
@@ -44,8 +45,10 @@ def set_fields(self):
         self.set_form_fields(form_field_dict)
 
     def set_post_data(self):
-        # Need to set form data so that validation on all post data occurs and
-        # places newly entered form data on the form object.
+        """
+            Need to set form data so that validation on all post data occurs and
+            places newly entered form data on the form object.
+        """
         self.form.data = self.post_data_dict
 
         # Specifically adding list field keys to the form so they are included
@@ -62,6 +65,9 @@ def set_post_data(self):
                         self.form.fields.update({key: field})
 
     def get_form(self):
+        """
+        Generate the form for view.
+        """
         self.set_fields()
         if self.post_data_dict is not None:
             self.set_post_data()

mongonaut/forms/widgets.py

@@ -19,6 +19,7 @@
 
 
 def get_widget(model_field, disabled=False):
+    """Choose which widget to display for a field."""
 
     attrs = get_attrs(model_field, disabled)
 
@@ -42,6 +43,7 @@ def get_widget(model_field, disabled=False):
 
 
 def get_attrs(model_field, disabled=False):
+    """Set attributes on the display widget."""
     attrs = {}
     attrs['class'] = 'span6 xlarge'
     if disabled or isinstance(model_field, ObjectIdField):

mongonaut/templatetags/mongonaut_tags.py

@@ -14,6 +14,7 @@
 
 @register.simple_tag()
 def get_document_value(document, key):
+    """Returns the display value of a field for a particular MongoDB document."""
     value = getattr(document, key)
     if isinstance(value, ObjectId):
         return value

mongonaut/views.py

@@ -173,7 +173,7 @@ def get_context_data(self, **kwargs):
         return context
 
     def post(self, request, *args, **kwargs):
-        """Creates new mongoengine records/"""
+        """Creates new mongoengine records."""
         # TODO - make sure to check the rights of the poster
         #self.get_queryset() # TODO - write something that grabs the document class better
         form_class = self.get_form_class()