Docstrings

exonetapi/result/Parser.py

@@ -19,7 +19,7 @@ def __init__(self, data):
     def parse(self):
         """Parse JSON string into a Resource or a list of Resources.
 
-        :return: list|Resource: List with Resources or a single Resource.
+        :return list|Resource: List with Resources or a single Resource.
         """
         if type(self.__json_data) is list:
             resources = []

exonetapi/structures/Relation.py

@@ -6,9 +6,9 @@ class Relation(object):
     def __init__(self, relation_name, origin_type, origin_id):
         """Relation constructor.
 
-        :param: str relation_name The name of the relation.
-        :param: str origin_type   The resource type of the origin resource.
-        :param: str origin_id     The resource ID of the origin resource.
+        :param str relation_name: The name of the relation.
+        :param str origin_type: The resource type of the origin resource.
+        :param str origin_id: The resource ID of the origin resource.
         """
         self.__name = relation_name
         self.__url = self.__urlPattern % (origin_type, origin_id, relation_name)
@@ -35,16 +35,16 @@ def get_resource_identifiers(self):
         """
         Get the resource identifiers for this relation.
 
-        :return ApiResourceSet|ApiResourceIdentifier The resource identifier or a resource set.
+        :return ApiResourceSet|ApiResourceIdentifier: The resource identifier or a resource set.
         """
         return self.__resourceIdentifiers
 
     def set_resource_identifiers(self, new_relationship):
         """
         Replace the related resource identifiers with new data.
 
-        :param ApiResourceSet|ApiResourceIdentifier new_relationship A new resource identifier or a new resource set.
-        :return self
+        :param ApiResourceSet|ApiResourceIdentifier new_relationship: A new resource identifier or a new resource set.
+        :return self:
         """
         self.__resourceIdentifiers = new_relationship
 

exonetapi/structures/Resource.py

@@ -63,4 +63,3 @@ def to_json_resource_identifier(self):
 
         return super().to_json()
 
-

exonetapi/structures/ResourceIdentifier.py

@@ -35,7 +35,7 @@ def related(self, name):
 
 
         :param name: The name of the relation.
-        :return: Relation The new relation.
+        :return Relation: The new relation.
         """
         return Relation(name, self.type(), self.id())
 
@@ -46,7 +46,7 @@ def relationship(self, name, *data):
 
         :param name: The name of the relation to set.
         :param data: The value of the relation, can be a Resource or a dict of Resources.
-        :return: self when setting a relationship, or the actual relationship when getting it
+        :return self: when setting a relationship, or the actual relationship when getting it
         """
         if len(data) is 1:
             return self.set_relationship(name, data[0])