Clarify documenation about env_key

frioux · Oct 24, 2015 · 34f0dc1 · 34f0dc1
1 parent 77c7fb2
commit 34f0dc1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,7 @@
 Revision history for {{$dist->name}}
 
 {{$NEXT}}
+ - Clarify documenation about env_key (Thanks for the request, Ron Savage!)
 
 0.002000  2015-09-30 20:58:12-07:00 America/Los_Angeles
  - Add decode_via/encode_via to allow other storage formats

diff --git a/lib/Config/Station.pm b/lib/Config/Station.pm
@@ -213,14 +213,19 @@ running the application as follows:
 The C<env_key> is a required attribute which affects everything about this
 module.
 
-The main thing that it does is set a prefix for all the env vars that override
+C<env_key> affects two classes of values:
+
+=head3 Meta Configuration
+
+These values use the C<env_key> as a suffix, and are documented further down.
+
+=head3 Normal Configuration
+
+These values use the C<env_key> as a prefix for env vars that override
 configuration keys.  To be clear, if you specify an C<env_key> of C<FOO>, an env
 var of C<FOO_BAR=BAZ> will pass C<< bar => 'BAZ' >> to the constructor of
 L</config_class>.
 
-The rest of the things that C<env_key> does are documented alongside their
-respective features.
-
 =head2 config_class
 
 The C<config_class> is a required attribute which determines the class that