add doc strings to new functions #73

OnroerendErfgoed · Apr 20, 2017 · 6b8306e · 6b8306e
1 parent 832b0b4
commit 6b8306e
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/crabpy/gateway/capakey.py b/crabpy/gateway/capakey.py
@@ -506,11 +506,23 @@ def __init__(self, **kwargs):
 
     @staticmethod
     def _parse_centroid(center):
+        '''
+        Parse response center from the CapakeyRestGateway to (CenterX, CenterY)
+        
+        :param center: response center from the CapakeyRestGateway
+        :return: (CenterX, CenterY)
+        '''
         coordinates = json.loads(center)["coordinates"]
         return coordinates[0], coordinates[1]
 
     @staticmethod
     def _parse_bounding_box(bounding_box):
+        '''
+        Parse response bounding box from the CapakeyRestGateway to (MinimumX, MinimumY, MaximumX, MaximumY)
+        
+        :param bounding_box: response bounding box from the CapakeyRestGateway
+        :return: (MinimumX, MinimumY, MaximumX, MaximumY)
+        '''
         coordinates = json.loads(bounding_box)["coordinates"]
         x_coords = [x for x, y in coordinates[0]]
         y_coords = [y for x, y in coordinates[0]]