Skip to content

Commit

Permalink
adjust doc to mention nested env variables
Browse files Browse the repository at this point in the history
  • Loading branch information
silvanmelchior-zuehlke committed Mar 11, 2024
1 parent ea0fcf6 commit 71e2aa2
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions confz/config_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class EnvSource(ConfigSource):
variable names are transformed to lowercase and all dashes are replaced by
underscores. The definitions below are not case-sensitive and can be written with
underscore or dash. An exception is `prefix`, which needs to match exactly.
Dot-notation can be used to access nested configurations."""
Separators can be used to create nested configurations."""

allow_all: bool = False
"""Allow potentially all environment variables to be read as config option."""
Expand All @@ -77,7 +77,9 @@ class EnvSource(ConfigSource):
"""Built in .env file loading with lower than environment precedence. Uses UTF-8
for decoding."""
nested_separator: str = "."
"""Separator will be used in nested environment variables."""
"""Separator which will be used in nested environment variables. Note that
dot-notation is not supported by some shells, so consider using an alternative
like double underscore."""


@dataclass
Expand Down

0 comments on commit 71e2aa2

Please sign in to comment.