From 3dfb05aab3e6835c5572de015203e27a045085ed Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Sat, 6 May 2017 21:41:33 +0100 Subject: [PATCH] lib: Fix documentation. --- src/lib.rs | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 67c06296..7faf06c6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,11 +1,10 @@ //! A crate parsing common XMPP elements into Rust structures. //! -//! Each module implements a `parse` function, which takes a minidom -//! `Element` reference and returns `Some(MessagePayload)` if the parsing -//! succeeded, None otherwise. +//! Each module implements the `TryFrom<&minidom::Element>` trait, which takes +//! a minidom `Element` reference and returns a `Result`. //! -//! Parsed structs can then be manipulated internally, and serialised back -//! before being sent over the wire. +//! Parsed structs can then be manipulated manually, and must be serialised +//! back before being sent over the wire. // Copyright (c) 2017 Emmanuel Gil Peyrot //