Add doc: Config:set()

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

1 files changed, 8 insertions, 0 deletions

diff --git a/src/config.rs b/src/config.rs
index 1019061..d8d36be 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -156,6 +156,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>,