fix documentation of StanzaError

12 years ago · 31efaaf1c8
1 changed files with 3 additions and 3 deletions
--- a/source/Network/Xmpp/Types.hs
+++ b/source/Network/Xmpp/Types.hs
@ -288,9 +288,9 @@ data PresenceType = Subscribe    | -- ^ Sender wants to subscribe to presence
                    Unavailable deriving (Eq, Read, Show)
 -- | All stanzas (IQ, message, presence) can cause errors, which in the Xmpp
-- stream looks like <stanza-kind to='sender' type='error'>. These errors are
+-- stream looks like @\<stanza-kind to=\'sender\' type=\'error\'\>@ . These
-- wrapped in the @StanzaError@ type.
+-- errors are wrapped in the @StanzaError@ type.  TODO: Sender XML is (optional
-- TODO: Sender XML is (optional and is) not yet included.
+-- and is) not yet included.
 data StanzaError = StanzaError
    { stanzaErrorType                         :: StanzaErrorType
    , stanzaErrorCondition                    :: StanzaErrorCondition