chore: fix documentations

This commit is contained in:
Dmitriy Pleshevskiy 2020-03-17 14:59:33 +03:00
parent 1ff1ff638f
commit ac420dc0a3
5 changed files with 25 additions and 21 deletions

View file

@ -139,7 +139,7 @@ cargo test
## Available features ## Available features
* **default** - ["macro", "primitives", "static"] * **default** - ["primitives"]
* **macro** - Activates `config!` macros for easy configure web application. * **macro** - Activates `config!` macros for easy configure web application.
* **array** - Add EnvString impl for vector type (uses optional `serde_json` package). * **array** - Add EnvString impl for vector type (uses optional `serde_json` package).
* **primitives** - Group for features: `numbers` and `bool`. * **primitives** - Group for features: `numbers` and `bool`.

View file

@ -8,4 +8,4 @@ edition = "2018"
[dependencies] [dependencies]
rocket = "0.4.2" rocket = "0.4.2"
itconfig = { path = '../../itconfig', feature = ["macro"] } itconfig = { path = '../../itconfig', features = ["macro"] }

View file

@ -1,6 +1,6 @@
[package] [package]
name = "itconfig" name = "itconfig"
version = "1.0.0" version = "1.0.1"
authors = ["Dmitriy Pleshevskiy <dmitriy@ideascup.me>"] authors = ["Dmitriy Pleshevskiy <dmitriy@ideascup.me>"]
description = "Easy build a configs from environment variables and use it in globally." description = "Easy build a configs from environment variables and use it in globally."
categories = ["config", "web-programming"] categories = ["config", "web-programming"]
@ -58,3 +58,8 @@ bool = []
[badges] [badges]
travis-ci = { repository = "icetemple/itconfig-rs" } travis-ci = { repository = "icetemple/itconfig-rs" }
maintenance = { status = "actively-developed" } maintenance = { status = "actively-developed" }
# https://docs.rs/about
[package.metadata.docs.rs]
all-features = true

View file

@ -120,7 +120,7 @@ fn main() {
## Available features ## Available features
* **default** - ["macro", "primitives", "static"] * **default** - ["primitives"]
* **macro** - Activates `config!` macros for easy configure web application. * **macro** - Activates `config!` macros for easy configure web application.
* **array** - Add EnvString impl for vector type (uses optional `serde_json` package). * **array** - Add EnvString impl for vector type (uses optional `serde_json` package).
* **primitives** - Group for features: `numbers` and `bool`. * **primitives** - Group for features: `numbers` and `bool`.

View file

@ -117,22 +117,22 @@
//! * **int** - Group for features: `i8`, `i16`, `i32`, `i64`, `i128` and `isize`. //! * **int** - Group for features: `i8`, `i16`, `i32`, `i64`, `i128` and `isize`.
//! * **uint** - Group for features: `u8`, `u16`, `u32`, `u64`, `u128` and `usize`. //! * **uint** - Group for features: `u8`, `u16`, `u32`, `u64`, `u128` and `usize`.
//! * **float** - Group for features: `f32` and `f64` //! * **float** - Group for features: `f32` and `f64`
//! * **i8** - impl EnvString for i8 type //! * **i8** - impl EnvString for `i8` type
//! * **i16** - impl EnvString for i16 type //! * **i16** - impl EnvString for `i16` type
//! * **i32** - impl EnvString for i32 type //! * **i32** - impl EnvString for `i32` type
//! * **i64** - impl EnvString for i64 type //! * **i64** - impl EnvString for `i64` type
//! * **i128** - impl EnvString for i128 type //! * **i128** - impl EnvString for `i128` type
//! * **isize** - impl EnvString for isize type //! * **isize** - impl EnvString for `isize` type
//! * **u8** - impl EnvString for u8 type //! * **u8** - impl EnvString for `u8` type
//! * **u16** - impl EnvString for u16 type //! * **u16** - impl EnvString for `u16` type
//! * **u32** - impl EnvString for u32 type //! * **u32** - impl EnvString for `u32` type
//! * **u64** - impl EnvString for u64 type //! * **u64** - impl EnvString for `u64` type
//! * **u128** - impl EnvString for u128 type //! * **u128** - impl EnvString for `u128` type
//! * **usize** - impl EnvString for usize type //! * **usize** - impl EnvString for `usize` type
//! * **f32** - impl EnvString for f32 type //! * **f32** - impl EnvString for `f32` type
//! * **f64** - impl EnvString for f64 type //! * **f64** - impl EnvString for `f64` type
//! * **bool** - impl EnvString for bool type //! * **bool** - impl EnvString for `bool` type
//!a //!
// Rustc lints. // Rustc lints.
@ -165,5 +165,4 @@ pub mod prelude {
#[cfg(feature = "macro")] #[cfg(feature = "macro")]
extern crate itconfig_macro; extern crate itconfig_macro;
#[cfg(feature = "macro")] #[cfg(feature = "macro")]
#[doc(hidden)]
pub use itconfig_macro::*; pub use itconfig_macro::*;