Comments and Documentation

This change adds a ton of comments and documentation across all the code.

Change-Id: Ifee0a2f534e8584f14b0f13af4dda8dc70eb7553
Signed-off-by: Parker Berberian <pberberian@iol.unh.edu>

1 files changed, 4 insertions, 6 deletions

diff --git a/src/api/serializers/booking_serializer.py b/src/api/serializers/booking_serializer.py
index 9b5c059..46a2348 100644
--- a/src/api/serializers/booking_serializer.py
+++ b/src/api/serializers/booking_serializer.py
@@ -25,7 +25,8 @@ class BookingField(serializers.Field):
 
     def to_representation(self, booking):
         """
-        Takes in a booking object.
+        Take in a booking object.
+
         Returns a dictionary of primitives representing that booking
         """
         ser = {}
@@ -75,8 +76,7 @@ class BookingField(serializers.Field):
 
     def to_internal_value(self, data):
         """
-        Takes in a dictionary of primitives
-        Returns a booking object
+        Take in a dictionary of primitives, and return a booking object.
 
         This is not going to be implemented or allowed.
         If someone needs to create a booking through the api,
@@ -146,9 +146,7 @@ class InterfaceField(serializers.Field):
         pass
 
     def to_internal_value(self, data):
-        """
-        takes in a serialized interface and creates an Interface model
-        """
+        """Take in a serialized interface and creates an Interface model."""
         mac = data['mac']
         bus_address = data['busaddr']
         switch_name = data['switchport']['switch_name']