summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-04-17 11:15:42 +0200
committerMatthias Beyer <mail@beyermatthias.de>2021-04-17 11:15:42 +0200
commitfeed306c34c6cec86ea8f0b0cca02369aaa0659b (patch)
tree83419ef599e9fba24c9c2164d2aa3043f8722f78
parent6bf5009a6ddbe00759aea2c707c818dc7fd82870 (diff)
Make clear why this method can fail
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
-rw-r--r--src/builder.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/builder.rs b/src/builder.rs
index c1318be..23090c6 100644
--- a/src/builder.rs
+++ b/src/builder.rs
@@ -75,7 +75,8 @@ impl ConfigBuilder {
/// This value can be overwritten by any [`Source`] or override.
///
/// # Errors
- /// Method can fail if `key` is not valid.
+ ///
+ /// Fails if `Expression::from_str(key)` fails.
pub fn set_default<T>(&mut self, key: &str, value: T) -> error::Result<&mut ConfigBuilder>
where
T: Into<Value>,
@@ -101,7 +102,7 @@ impl ConfigBuilder {
///
/// # Errors
///
- /// Method can fail if `key` is not valid.
+ /// Fails if `Expression::from_str(key)` fails.
pub fn set_override<T>(&mut self, key: &str, value: T) -> error::Result<&mut ConfigBuilder>
where
T: Into<Value>,