diff options
| author | mathieui <mathieui@mathieui.net> | 2020-12-10 19:20:23 +0100 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2020-12-10 19:22:40 +0100 |
| commit | 95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c (patch) | |
| tree | ef3086be7313a8e61e51b7a3efed302d0e154cb0 /slixmpp/plugins/xep_0107/user_mood.py | |
| parent | 010bf6dd70a44d9e9087336bc955a591ab9248b3 (diff) | |
| download | slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.tar.gz slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.tar.bz2 slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.tar.xz slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.zip | |
docs: update docstrings for sphinx conformity
Remove most references to timeout/callback/ifrom/timeout_callbacks args
Diffstat (limited to 'slixmpp/plugins/xep_0107/user_mood.py')
| -rw-r--r-- | slixmpp/plugins/xep_0107/user_mood.py | 23 |
1 files changed, 4 insertions, 19 deletions
diff --git a/slixmpp/plugins/xep_0107/user_mood.py b/slixmpp/plugins/xep_0107/user_mood.py index c745671f..83155f92 100644 --- a/slixmpp/plugins/xep_0107/user_mood.py +++ b/slixmpp/plugins/xep_0107/user_mood.py @@ -45,17 +45,10 @@ class XEP_0107(BasePlugin): """ Publish the user's current mood. - Arguments: - value -- The name of the mood to publish. - text -- Optional natural-language description or reason - for the mood. - options -- Optional form of publish options. - ifrom -- Specify the sender's JID. - timeout -- The length of time (in seconds) to wait for a response - before exiting the send call if blocking is used. - Defaults to slixmpp.xmlstream.RESPONSE_TIMEOUT - callback -- Optional reference to a stream handler function. Will - be executed when a reply stanza is received. + :param value: The name of the mood to publish. + :param text: Optional natural-language description or reason + for the mood. + :param options: Optional form of publish options. """ mood = UserMood() mood['value'] = value @@ -69,14 +62,6 @@ class XEP_0107(BasePlugin): timeout_callback=None): """ Clear existing user mood information to stop notifications. - - Arguments: - ifrom -- Specify the sender's JID. - timeout -- The length of time (in seconds) to wait for a response - before exiting the send call if blocking is used. - Defaults to slixmpp.xmlstream.RESPONSE_TIMEOUT - callback -- Optional reference to a stream handler function. Will - be executed when a reply stanza is received. """ mood = UserMood() self.xmpp['xep_0163'].publish(mood, node=UserMood.namespace, |