From 5ae85aa8844a8ecc496f70e93652f291dbf0e7ec Mon Sep 17 00:00:00 2001 From: lumi Date: Tue, 28 Feb 2017 12:38:00 +0100 Subject: [PATCH] add #![deny(missing_docs)] and documentation --- src/lib.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 91a744bb..74f1d3cc 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,5 @@ +#![deny(missing_docs)] + //! Provides a type for Jabber IDs. //! //! For usage, check the documentation on the `Jid` struct. @@ -11,6 +13,7 @@ use std::str::FromStr; /// An error that signifies that a `Jid` cannot be parsed from a string. #[derive(Debug, Clone, PartialEq, Eq)] pub enum JidParseError { + /// Happens when there is no domain. (really, only happens when the string is empty) NoDomain, }