From df91211448c17976a1437488cd3dc64d9c5002d6 Mon Sep 17 00:00:00 2001 From: Marek Marecki Date: Mon, 18 Mar 2013 16:20:19 +0100 Subject: [PATCH] Minor documentation fix in diaspy/models.py --- diaspy/client.py | 1 - diaspy/conversations.py | 6 +++--- diaspy/models.py | 4 +++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/diaspy/client.py b/diaspy/client.py index 7d1678d..460495e 100644 --- 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 3a844ad..0bcbc34 100644 --- 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 572c288..344b443 100644 --- 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. -- 2.25.1