From 60ca2baa4e827a5c454a0bfbf2544055a93cb385 Mon Sep 17 00:00:00 2001 From: Moritz Kiefer Date: Tue, 15 Jan 2013 21:03:53 +0100 Subject: [PATCH] Improve documentation --- diaspy/diaspy.py | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/diaspy/diaspy.py b/diaspy/diaspy.py index c9783c9..2ec0d10 100755 --- a/diaspy/diaspy.py +++ b/diaspy/diaspy.py @@ -25,7 +25,14 @@ class Client: self._session = requests.Session() def login(self, username, password): - """blablablalbla""" + """This function is used to connect to the pod and log in. + + :param username: The username used to log in. + :type username: str. + :param password: The password used to log in. + :type password: str. + + """ self._username = username self._password = password r = self._session.get(self._pod + "/users/sign_in") @@ -39,7 +46,14 @@ class Client: r = self._session.post(self._pod + "/users/sign_in", data=data) def post(self, text, aspect_id='public'): - """blablablalbla""" + """This function sends a post to an aspect + + :param text: Text to post. + :type text: str + :param aspect_id: Aspect id to send post to. + :type aspect_id: str. + + """ r = self._session.get(self._pod + "/stream") token = self._token_regex.search(r.text).group(1) data = {'aspect_ids': aspect_id, -- 2.25.1