Merge pull request #293 from robjtede/doc-auto-cfg

Document crate feature guarded items on docs.rs

Author: pksunkara

Cargo.toml

@@ -56,4 +56,5 @@ required-features = ["completion"]
 no_individual_tags = true
 
 [package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
 all-features = true

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<T = ()> = StdResult<T, Error>;

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;