Merge pull request #5 from ramiroaisen/core-docs

core: improve doc examples
ramiroaisen · Jul 6, 2024 · d1da435 · d1da435
2 parents a21eba7 + 59ae340
commit d1da435
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 7 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -25,9 +25,9 @@ struct MyConfig {
 
 let mut loader = ConfigLoader::<MyConfig>::new();
 
+loader.defaults()?;
 loader.file("config.json", Format::Json)?;
 loader.env()?;
-loader.defaults()?;
 
 // config have the type MyConfig here
 let config = loader.finish()?;  

diff --git a/metre-macros/Cargo.toml b/metre-macros/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "metre-macros"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 license = "Apache-2.0"
 description = "Macros for the metre crate"

diff --git a/metre/Cargo.toml b/metre/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "metre"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 description = "Metre, the configuration loader for Rust"
 repository = "https://github.com/ramiroaisen/metre"

diff --git a/metre/src/lib.rs b/metre/src/lib.rs
@@ -41,9 +41,9 @@
 //! 
 //! let mut loader = ConfigLoader::<MyConfig>::new();
 //!
+//! loader.defaults()?;
 //! loader.file("config.json", Format::Json)?;
 //! loader.env()?;
-//! loader.defaults()?;
 //!
 //! // config have the type MyConfig here, or loader.finish() returns an error
 //! let config = loader.finish()?;

diff --git a/metre/tests/tests.rs b/metre/tests/tests.rs
@@ -18,9 +18,9 @@ fn readme_example() -> Result<(), Box<dyn std::error::Error>> {
 
   let mut loader = ConfigLoader::<MyConfig>::new();
 
+  loader.defaults()?;
   loader.file("config.json", Format::Json)?;
   loader.env()?;
-  loader.defaults()?;
 
   // config have the type MyConfig here, or loader.finish() returns an error
   let config = loader.finish()?;