Environment: add a rustdoc comment

1 files changed, 4 insertions, 0 deletions

diff --git a/src/env.rs b/src/env.rs
index 432df2c..683459a 100644
--- a/src/env.rs
+++ b/src/env.rs
@@ -5,6 +5,10 @@ use crate::map::Map;
 use crate::source::Source;
 use crate::value::{Value, ValueKind};
 
+/// An environment source collects a dictionary of environment variables values into a hierarchical
+/// config Value type. We have to be aware how the config tree is created from the environment
+/// dictionary, therefore we are mindful about prefixes for the environment keys, level separators,
+/// encoding form (kebab, snake case) etc.
 #[must_use]
 #[derive(Clone, Debug, Default)]
 pub struct Environment {