summaryrefslogtreecommitdiff
path: root/sleekxmpp/xmlstream/matcher/id.py
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-12-04 16:26:14 -0800
committerLance Stout <lancestout@gmail.com>2011-12-04 16:26:14 -0800
commit2586fdffda9dac5ee56664c74e71bd54ae47ee18 (patch)
tree8c3eff0ed8ed6539b7eace355a90e8ede9634d0a /sleekxmpp/xmlstream/matcher/id.py
parentc9dc9ec11e8ef141234d8376fe8882ae13babbf8 (diff)
downloadslixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.gz
slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.bz2
slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.xz
slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.zip
Update api docs for handlers and matchers
Diffstat (limited to 'sleekxmpp/xmlstream/matcher/id.py')
-rw-r--r--sleekxmpp/xmlstream/matcher/id.py25
1 files changed, 11 insertions, 14 deletions
diff --git a/sleekxmpp/xmlstream/matcher/id.py b/sleekxmpp/xmlstream/matcher/id.py
index 0c8ce2d8..11ab70bb 100644
--- a/sleekxmpp/xmlstream/matcher/id.py
+++ b/sleekxmpp/xmlstream/matcher/id.py
@@ -1,9 +1,12 @@
+# -*- coding: utf-8 -*-
"""
- SleekXMPP: The Sleek XMPP Library
- Copyright (C) 2010 Nathanael C. Fritz
- This file is part of SleekXMPP.
+ sleekxmpp.xmlstream.matcher.id
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- See the file LICENSE for copying permission.
+ Part of SleekXMPP: The Sleek XMPP Library
+
+ :copyright: (c) 2011 Nathanael C. Fritz
+ :license: MIT, see LICENSE for more details
"""
from sleekxmpp.xmlstream.matcher.base import MatcherBase
@@ -14,19 +17,13 @@ class MatcherId(MatcherBase):
"""
The ID matcher selects stanzas that have the same stanza 'id'
interface value as the desired ID.
-
- Methods:
- match -- Overrides MatcherBase.match.
"""
def match(self, xml):
- """
- Compare the given stanza's 'id' attribute to the stored
- id value.
-
- Overrides MatcherBase.match.
+ """Compare the given stanza's ``'id'`` attribute to the stored
+ ``id`` value.
- Arguments:
- xml -- The stanza to compare against.
+ :param xml: The :class:`~sleekxmpp.xmlstream.stanzabase.ElementBase`
+ stanza to compare against.
"""
return xml['id'] == self._criteria