From 613323b5fb71dea6af7d2cdacfbadffc77a67ad9 Mon Sep 17 00:00:00 2001 From: Lance Stout Date: Mon, 23 Jul 2012 02:56:53 -0700 Subject: Finish docstrings for jid.py --- sleekxmpp/jid.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/sleekxmpp/jid.py b/sleekxmpp/jid.py index 2adc4372..7597885a 100644 --- a/sleekxmpp/jid.py +++ b/sleekxmpp/jid.py @@ -296,8 +296,13 @@ def _format_jid(local=None, domain=None, resource=None): class InvalidJID(ValueError): - pass + """ + Raised when attempting to create a JID that does not pass validation. + It can also be raised if modifying an existing JID in such a way as + to make it invalid, such trying to remove the domain from an existing + full JID while the local and resource portions still exist. + """ # pylint: disable=R0903 class UnescapedJID(object): -- cgit v1.2.3