add #![deny(missing_docs)] and documentation
This commit is contained in:
parent
eb9a121e70
commit
5ae85aa884
1 changed files with 3 additions and 0 deletions
|
@ -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,
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in a new issue