diff options
author | mathieui <mathieui@mathieui.net> | 2015-02-24 18:58:40 +0100 |
---|---|---|
committer | mathieui <mathieui@mathieui.net> | 2015-02-24 22:47:15 +0100 |
commit | c66a4d4097a249efc029b761d6150378a54bf702 (patch) | |
tree | b25d5872f0ab8036c8b05b4207b03163f4bc7868 /docs/glossary.rst | |
parent | e112e864756f1222a044ee28e3c13c5925618b0c (diff) | |
download | slixmpp-c66a4d4097a249efc029b761d6150378a54bf702.tar.gz slixmpp-c66a4d4097a249efc029b761d6150378a54bf702.tar.bz2 slixmpp-c66a4d4097a249efc029b761d6150378a54bf702.tar.xz slixmpp-c66a4d4097a249efc029b761d6150378a54bf702.zip |
Update the documentation and examples
- update most of the examples with slixmpp
- change the help channels pointed out in the doc
- add a page listing differences from slixmpp and how to use asyncio
nicely with slixmpp
- fix some in-code rst documentation
Diffstat (limited to 'docs/glossary.rst')
-rw-r--r-- | docs/glossary.rst | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst index 35d2dc86..435df102 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -9,21 +9,20 @@ Glossary stream handler A callback function that accepts stanza objects pulled directly from the XML stream. A stream handler is encapsulated in a - object that includes a :term:`Matcher` object, and which provides - additional semantics. For example, the ``Waiter`` handler wrapper - blocks thread execution until a matching stanza is received. + object that includes a :class:`Matcher <.MatcherBase>` object, and + which provides additional semantics. For example, the + :class:`.Waiter` handler wrapper blocks thread execution until a + matching stanza is received. event handler A callback function that responds to events raised by - ``XMLStream.event``. An event handler may be marked as - threaded, allowing it to execute outside of the main processing - loop. + :meth:`.XMLStream.event`. stanza object - Informally may refer both to classes which extend ``ElementBase`` - or ``StanzaBase``, and to objects of such classes. + Informally may refer both to classes which extend :class:`.ElementBase` + or :class:`.StanzaBase`, and to objects of such classes. - A stanza object is a wrapper for an XML object which exposes ``dict`` + A stanza object is a wrapper for an XML object which exposes :class:`dict` like interfaces which may be assigned to, read from, or deleted. stanza plugin |