From ac420dc0a3f50dd677fe9556249c3c7dea33de39 Mon Sep 17 00:00:00 2001 From: Dmitriy Pleshevskiy Date: Tue, 17 Mar 2020 14:59:33 +0300 Subject: [PATCH] chore: fix documentations --- README.md | 2 +- examples/rocket/Cargo.toml | 2 +- itconfig/Cargo.toml | 7 ++++++- itconfig/README.md | 2 +- itconfig/src/lib.rs | 33 ++++++++++++++++----------------- 5 files changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d9cbe60..8951dd8 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,7 @@ cargo test ## Available features -* **default** - ["macro", "primitives", "static"] +* **default** - ["primitives"] * **macro** - Activates `config!` macros for easy configure web application. * **array** - Add EnvString impl for vector type (uses optional `serde_json` package). * **primitives** - Group for features: `numbers` and `bool`. diff --git a/examples/rocket/Cargo.toml b/examples/rocket/Cargo.toml index 738d048..0ae3ede 100644 --- a/examples/rocket/Cargo.toml +++ b/examples/rocket/Cargo.toml @@ -8,4 +8,4 @@ edition = "2018" [dependencies] rocket = "0.4.2" -itconfig = { path = '../../itconfig', feature = ["macro"] } +itconfig = { path = '../../itconfig', features = ["macro"] } diff --git a/itconfig/Cargo.toml b/itconfig/Cargo.toml index e25f95c..fab37f0 100644 --- a/itconfig/Cargo.toml +++ b/itconfig/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "itconfig" -version = "1.0.0" +version = "1.0.1" authors = ["Dmitriy Pleshevskiy "] description = "Easy build a configs from environment variables and use it in globally." categories = ["config", "web-programming"] @@ -58,3 +58,8 @@ bool = [] [badges] travis-ci = { repository = "icetemple/itconfig-rs" } maintenance = { status = "actively-developed" } + + +# https://docs.rs/about +[package.metadata.docs.rs] +all-features = true diff --git a/itconfig/README.md b/itconfig/README.md index cb9fbbc..26fbd77 100644 --- a/itconfig/README.md +++ b/itconfig/README.md @@ -120,7 +120,7 @@ fn main() { ## Available features -* **default** - ["macro", "primitives", "static"] +* **default** - ["primitives"] * **macro** - Activates `config!` macros for easy configure web application. * **array** - Add EnvString impl for vector type (uses optional `serde_json` package). * **primitives** - Group for features: `numbers` and `bool`. diff --git a/itconfig/src/lib.rs b/itconfig/src/lib.rs index f2d608d..67297fa 100644 --- a/itconfig/src/lib.rs +++ b/itconfig/src/lib.rs @@ -117,22 +117,22 @@ //! * **int** - Group for features: `i8`, `i16`, `i32`, `i64`, `i128` and `isize`. //! * **uint** - Group for features: `u8`, `u16`, `u32`, `u64`, `u128` and `usize`. //! * **float** - Group for features: `f32` and `f64` -//! * **i8** - impl EnvString for i8 type -//! * **i16** - impl EnvString for i16 type -//! * **i32** - impl EnvString for i32 type -//! * **i64** - impl EnvString for i64 type -//! * **i128** - impl EnvString for i128 type -//! * **isize** - impl EnvString for isize type -//! * **u8** - impl EnvString for u8 type -//! * **u16** - impl EnvString for u16 type -//! * **u32** - impl EnvString for u32 type -//! * **u64** - impl EnvString for u64 type -//! * **u128** - impl EnvString for u128 type -//! * **usize** - impl EnvString for usize type -//! * **f32** - impl EnvString for f32 type -//! * **f64** - impl EnvString for f64 type -//! * **bool** - impl EnvString for bool type -//!a +//! * **i8** - impl EnvString for `i8` type +//! * **i16** - impl EnvString for `i16` type +//! * **i32** - impl EnvString for `i32` type +//! * **i64** - impl EnvString for `i64` type +//! * **i128** - impl EnvString for `i128` type +//! * **isize** - impl EnvString for `isize` type +//! * **u8** - impl EnvString for `u8` type +//! * **u16** - impl EnvString for `u16` type +//! * **u32** - impl EnvString for `u32` type +//! * **u64** - impl EnvString for `u64` type +//! * **u128** - impl EnvString for `u128` type +//! * **usize** - impl EnvString for `usize` type +//! * **f32** - impl EnvString for `f32` type +//! * **f64** - impl EnvString for `f64` type +//! * **bool** - impl EnvString for `bool` type +//! // Rustc lints. @@ -165,5 +165,4 @@ pub mod prelude { #[cfg(feature = "macro")] extern crate itconfig_macro; #[cfg(feature = "macro")] -#[doc(hidden)] pub use itconfig_macro::*; \ No newline at end of file