Minor documentation fix in diaspy/models.py

diff --git a/diaspy/client.py b/diaspy/client.py
index 7d1678da111433cbdcf346f2adbf9e9616400686..460495e5e110107cbc2fad56bba03c215497ac36 100644 (file)
--- a/diaspy/client.py
+++ b/diaspy/client.py
@@ -269,7 +269,6 @@ class Client:
         if r.status_code != 404:
             raise Exception('wrong status code: ' + str(r.status_code))
 
-
     def get_mailbox(self):
         """This functions returns a list of messages found in the conversation.
 

diff --git a/diaspy/conversations.py b/diaspy/conversations.py
index 3a844ad7884b518fd5db24b29314effba9948808..0bcbc34d3bcdf451b4253a061ae296380b490ec2 100644 (file)
--- a/diaspy/conversations.py
+++ b/diaspy/conversations.py
@@ -10,8 +10,8 @@ class Conversation:
 
     def __init__(self, conv_id, client):
         """
-        :param conversation_id: id of the post and not the guid!
-        :type conversation_id: str
+        :param conv_id: id of the post and not the guid!
+        :type conv_id: str
         :param client: client object used to authenticate
         :type client: client.Client
 
@@ -24,7 +24,7 @@ class Conversation:
         self.conv_id = conv_id
 
     def get_data(self):
-        """ returns the plain json data
+        """ returns the plain json data representing conversation.
         """
         r = self._client.session.get(self._client.pod +
                                      '/conversations/' +

diff --git a/diaspy/models.py b/diaspy/models.py
index 572c2882f859818be70160338fb5dd243cf8df33..344b4430503ec0b47bf635d8bdf4d2a3e97140e0 100644 (file)
--- a/diaspy/models.py
+++ b/diaspy/models.py
@@ -6,6 +6,7 @@ class Post:
 
     .. note::
         Remember that you need to have access to the post.
+        Remember that you also need to be logged in.
 
     """
 
@@ -35,7 +36,8 @@ class Post:
             raise Exception('wrong status code: ' + str(r.status_code))
 
     def like(self):
-        """This function likes a post
+        """This function likes a post. 
+        It abstracts the 'Like' functionality.
 
         :returns: dict -- json formatted like object.