summaryrefslogtreecommitdiff
path: root/sleekxmpp/xmlstream/stanzabase.py
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-11-21 23:17:39 -0800
committerLance Stout <lancestout@gmail.com>2011-11-21 23:17:39 -0800
commit4498e992a2b082917a6b6cc855ed1e38cf905867 (patch)
tree8b413c3c14871a8e90255525ad514ac96c55b9f8 /sleekxmpp/xmlstream/stanzabase.py
parent2d610dfdc8738cb8c94341dd1bf80533ec4faa7a (diff)
downloadslixmpp-4498e992a2b082917a6b6cc855ed1e38cf905867.tar.gz
slixmpp-4498e992a2b082917a6b6cc855ed1e38cf905867.tar.bz2
slixmpp-4498e992a2b082917a6b6cc855ed1e38cf905867.tar.xz
slixmpp-4498e992a2b082917a6b6cc855ed1e38cf905867.zip
Add more stanzabase docs
Diffstat (limited to 'sleekxmpp/xmlstream/stanzabase.py')
-rw-r--r--sleekxmpp/xmlstream/stanzabase.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/sleekxmpp/xmlstream/stanzabase.py b/sleekxmpp/xmlstream/stanzabase.py
index 3c5cf8df..2af5ec3c 100644
--- a/sleekxmpp/xmlstream/stanzabase.py
+++ b/sleekxmpp/xmlstream/stanzabase.py
@@ -140,7 +140,7 @@ class ElementBase(object):
>>> message['custom']['custom'] # Must use all interfaces
'bar'
- If the plugin sets the value is_extension = True, then both setting
+ If the plugin sets :attr:`is_extension` to ``True``, then both setting
and getting an interface value that is the same as the plugin's
plugin_attrib value will work, as so::
@@ -1087,12 +1087,12 @@ class ElementBase(object):
class StanzaBase(ElementBase):
"""
- StanzaBase provides the foundation for all other stanza objects used by
- SleekXMPP, and defines a basic set of interfaces common to nearly
- all stanzas. These interfaces are the 'id', 'type', 'to', and 'from'
- attributes. An additional interface, 'payload', is available to access
- the XML contents of the stanza. Most stanza objects will provided more
- specific interfaces, however.
+ StanzaBase provides the foundation for all other stanza objects used
+ by SleekXMPP, and defines a basic set of interfaces common to nearly
+ all stanzas. These interfaces are the ``'id'``, ``'type'``, ``'to'``,
+ and ``'from'`` attributes. An additional interface, ``'payload'``, is
+ available to access the XML contents of the stanza. Most stanza objects
+ will provided more specific interfaces, however.
**Stanza Interfaces:**