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_0108 | |
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_0108')
-rw-r--r-- | slixmpp/plugins/xep_0108/user_activity.py | 27 |
1 files changed, 6 insertions, 21 deletions
diff --git a/slixmpp/plugins/xep_0108/user_activity.py b/slixmpp/plugins/xep_0108/user_activity.py index d66ed9c4..089269bd 100644 --- a/slixmpp/plugins/xep_0108/user_activity.py +++ b/slixmpp/plugins/xep_0108/user_activity.py @@ -39,19 +39,12 @@ class XEP_0108(BasePlugin): """ Publish the user's current activity. - Arguments: - general -- The required general category of the activity. - specific -- Optional specific activity being done as part - of the general category. - text -- Optional natural-language description or reason - for the activity. - 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 general: The required general category of the activity. + :param specific: Optional specific activity being done as part + of the general category. + :param text: Optional natural-language description or reason + for the activity. + :param options: Optional form of publish options. """ activity = UserActivity() activity['value'] = (general, specific) @@ -66,14 +59,6 @@ class XEP_0108(BasePlugin): timeout_callback=None): """ Clear existing user activity 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. """ activity = UserActivity() self.xmpp['xep_0163'].publish(activity, node=UserActivity.namespace, |