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_0086 | |
| 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_0086')
| -rw-r--r-- | slixmpp/plugins/xep_0086/legacy_error.py | 2 | ||||
| -rw-r--r-- | slixmpp/plugins/xep_0086/stanza.py | 14 |
2 files changed, 7 insertions, 9 deletions
diff --git a/slixmpp/plugins/xep_0086/legacy_error.py b/slixmpp/plugins/xep_0086/legacy_error.py index 0a6e0e87..e2ad41db 100644 --- a/slixmpp/plugins/xep_0086/legacy_error.py +++ b/slixmpp/plugins/xep_0086/legacy_error.py @@ -26,6 +26,8 @@ class XEP_0086(BasePlugin): Also see <http://xmpp.org/extensions/xep-0086.html>. Configuration Values: + :: + override -- Indicates if applying legacy error codes should be done automatically. Defaults to True. If False, then inserting legacy error codes can diff --git a/slixmpp/plugins/xep_0086/stanza.py b/slixmpp/plugins/xep_0086/stanza.py index a28abafa..6043308b 100644 --- a/slixmpp/plugins/xep_0086/stanza.py +++ b/slixmpp/plugins/xep_0086/stanza.py @@ -22,6 +22,8 @@ class LegacyError(ElementBase): Also see <http://xmpp.org/extensions/xep-0086.html>. Example legacy error stanzas: + :: + <error xmlns="jabber:client" code="501" type="cancel"> <feature-not-implemented xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" /> @@ -32,13 +34,8 @@ class LegacyError(ElementBase): xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" /> </error> - Attributes: - error_map -- A map of error conditions to error types and - code values. - Methods: - setup -- Overrides ElementBase.setup - set_condition -- Remap the type and code interfaces when a - condition is set. + :var error_map: A map of error conditions to error types and + code values. """ name = 'legacy' @@ -79,8 +76,7 @@ class LegacyError(ElementBase): Set the error type and code based on the given error condition value. - Arguments: - value -- The new error condition. + :param value: The new error condition. """ self.parent().set_condition(value) |