Inline documentation cleanup

edivorce/apps/core/models.py

@@ -23,14 +23,10 @@ class BceidUser(models.Model):
         return 'BCeID User %s' % self.user_guid
 
 
-
 @python_2_unicode_compatible
 class Question(models.Model):
     """
-    Questions being asked of the user, later assembled into LegalForms.
-
-    NOTE: The content and interaction of the question is defined in the
-    template; the name and description field here are for admin use.
+    Questions being asked of the user.
     """
 
     key = models.TextField(primary_key=True)
@@ -46,12 +42,13 @@ class Question(models.Model):
     """ Convenience for listing these in the admin """
 
     required = models.TextField(blank=True)
+    """ 'Required', 'Conditional', or '' [blank = not required] """
 
     conditional_target = models.TextField(blank=True)
+    """ For conditionally required questions, this is the other question that it is conditional upon """
 
     reveal_response = models.TextField(blank=True)
-
-
+    """ The value of the other question that makes this question required """
 
     class Meta:
         ordering = ('summary_order', )

edivorce/apps/core/serializer.py

@@ -1,5 +1,5 @@
 from rest_framework import serializers
-from .models import Question, UserResponse, User
+from .models import UserResponse
 
 
 class UserResponseSerializer(serializers.ModelSerializer):
@@ -13,7 +13,6 @@ class UserResponseSerializer(serializers.ModelSerializer):
     def create(self, validated_data):
         response = UserResponse(**validated_data)
         response.save()
-
         return response
 
     def update(self, instance, validated_data):

edivorce/apps/core/urls.py

@@ -6,7 +6,7 @@ handler404 = 'core.views.main.page_not_found'
 handler500 = 'core.views.main.server_error'
 
 urlpatterns = [
-    url(r'^guide$', styleguide.guide),
+    # url(r'^guide$', styleguide.guide),
     url(r'^api/response$', api.UserResponseHandler.as_view()),
     url(r'^login', main.login, name="login"),
     url(r'^bceid', localdev.bceid, name="bceid"),

edivorce/apps/core/views/pdf.py

@@ -11,24 +11,27 @@ from ..utils.user_response import get_responses_from_db
 
 @bceid_required
 def form(request, form_number):
+    """
+    View for rendering PDF's and previews
+    """
     user = BceidUser.objects.get(user_guid=request.bceid_user.guid)
     responses = get_responses_from_db(user)
 
     if form_number == "38_claimant1":
         form_number = "38"
-        responses = add_claimant_info(responses, '_you')
+        responses = __add_claimant_info(responses, '_you')
     elif form_number == "38_claimant2":
         form_number = "38"
-        responses = add_claimant_info(responses, '_spouse')
+        responses = __add_claimant_info(responses, '_spouse')
 
-    return render_form(request, 'form%s' % form_number,
+    return __render_form(request, 'form%s' % form_number,
                        {
                            "css_root": settings.WEASYPRINT_CSS_LOOPBACK,
                            "responses" : responses
                        })
 
 
-def render_form(request, form_name, context):
+def __render_form(request, form_name, context):
 
     output_as_html = request.GET.get('html', None) is not None
 
@@ -54,7 +57,7 @@ def render_form(request, form_name, context):
         return response
 
 
-def add_claimant_info(responses, claimant):
+def __add_claimant_info(responses, claimant):
     claimant_info = {}
     for key in responses:
         if key.endswith(claimant):

edivorce/apps/core/views/styleguide.py

@@ -2,4 +2,7 @@ from django.shortcuts import render
 
 
 def guide(request):
+    """
+    Visual design styles
+    """
     return render(request, 'styleguide/guide.html')