Merge pull request #181 from matthiasbeyer/set-doc

Documentation for `Config::set*()`

1 files changed, 9 insertions, 0 deletions

diff --git a/src/config.rs b/src/config.rs
index 1019061..cfd865a 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -139,6 +139,7 @@ impl Config {
         Ok(self)
     }
 
+    /// Set a default `value` at `key`
     pub fn set_default<T>(&mut self, key: &str, value: T) -> Result<&mut Config>
     where
         T: Into<Value>,
@@ -156,6 +157,14 @@ impl Config {
         self.refresh()
     }
 
+    /// Set an overwrite
+    ///
+    /// This function sets an overwrite value.
+    /// The overwrite `value` is written to the `key` location on every `refresh()`
+    ///
+    /// # Warning
+    ///
+    /// Errors if config is frozen
     pub fn set<T>(&mut self, key: &str, value: T) -> Result<&mut Config>
     where
         T: Into<Value>,