diff --git a/Cargo.toml b/Cargo.toml index a5dd834..058b15d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -56,4 +56,5 @@ required-features = ["completion"] no_individual_tags = true [package.metadata.docs.rs] +rustdoc-args = ["--cfg", "docsrs"] all-features = true diff --git a/src/error.rs b/src/error.rs index e9cf9ab..dc86560 100644 --- a/src/error.rs +++ b/src/error.rs @@ -10,5 +10,5 @@ pub enum Error { IO(#[from] IoError), } -/// Result type where errors are of type [Error](crate::error::Error) +/// Result type where errors are of type [Error](enum@Error). pub type Result = StdResult; diff --git a/src/lib.rs b/src/lib.rs index 46bf30c..68dfd2b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -30,6 +30,7 @@ //! By default `editor` and `password` are enabled. #![deny(clippy::all)] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub use console;