Merge pull request #66 from FishHooks/master

Modified and corrected some docstrings

Author: brianjmiller

tincan/agent.py

@@ -15,6 +15,13 @@
 from tincan.serializable_base import SerializableBase
 from tincan.agent_account import AgentAccount
 
+"""
+
+.. module:: Agent
+   :synopsis: The Agent object that contains the information about an Agent
+
+"""
+
 class Agent(SerializableBase):
 
     _props_req = [

tincan/conversions/iso8601.py

@@ -39,6 +39,7 @@ def make_timedelta(value):
     :type value: str | unicode | float | int | datetime.timedelta | dict
     :return: the value after conversion
     :rtype: datetime.timedelta
+
     """
 
     if isinstance(value, basestring):
@@ -88,6 +89,7 @@ def jsonify_timedelta(value):
     :type value: datetime.timedelta
     :return: the value after conversion
     :rtype unicode
+
     """
 
     assert isinstance(value, datetime.timedelta)
@@ -153,6 +155,7 @@ def make_datetime(value):
     :return: the value after conversion
     :rtype: :class:`datetime.datetime`
     :raises ValueError | TypeError
+
     """
     result = _make_datetime(value)
     if not result.tzinfo:

tincan/documents/document.py

@@ -28,6 +28,7 @@ class Document(Base):
     :type etag: unicode
     :param timestamp: The timestamp of this document
     :type timestamp: :class:`datetime.datetime`
+
     """
     _props_req = [
         'id',
@@ -48,6 +49,7 @@ def id(self):
         :setter: Tries to convert to unicode
         :setter type: str | unicode
         :rtype: unicode
+
         """
         return self._id
 
@@ -64,6 +66,7 @@ def content_type(self):
         :setter: Tries to convert to unicode
         :setter type: str | unicode
         :rtype: unicode
+
         """
         return self._content_type
 
@@ -80,6 +83,7 @@ def content(self):
         :setter: Tries to convert to bytearray.
         :setter type: str | unicode | bytearray
         :rtype: bytearray
+
         """
         return self._content
 
@@ -97,6 +101,7 @@ def etag(self):
         :setter: Tries to convert to unicode
         :setter type: str | unicode
         :rtype: unicode
+
         """
         return self._etag
 
@@ -126,6 +131,7 @@ def timestamp(self):
 
         :setter type: :class:`datetime.datetime` | unicode | str | int | float | dict | tuple | None
         :rtype: :class:`datetime.datetime`
+
         """
         return self._timestamp
 

tincan/statement_base.py

@@ -22,6 +22,13 @@
 from tincan.attachment_list import AttachmentList
 from tincan.conversions.iso8601 import make_datetime
 
+"""
+
+.. module:: StatementBase
+   :synopsis: The base object for both Statement and SubStatement
+
+"""
+
 class StatementBase(SerializableBase):
 
     _props_req = [