Skip to content

Commit

Permalink
Small fixes in docstrings and documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
deepaerial committed Jun 7, 2022
1 parent 314a93e commit a374040
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion confz/confz_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class ConfZCLArgSource(ConfZSource):
"""Certain command line arguments can be mapped to config arguments with a different
name. The map does not need to include the two dashes at the beginning."""
nested_separator: str = "."
"""Separator will be used in nested environment variables."""
"""Separator will be used in nested command line arguments."""


@dataclass
Expand Down
2 changes: 1 addition & 1 deletion confz/loaders/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def update_dict_recursively(cls, original_dict: Dict, update_dict: Dict):

@classmethod
def transform_nested_dicts(
cls, dict_in: Dict[str, Any], separator: str
cls, dict_in: Dict[str, Any], separator: str = "."
) -> Dict[str, Any]:
"""Transform dictionaries into nested dictionaries, using a separator in the
keys as hint.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/sources_loaders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are multiple config sources which support a heterogeneous set of use-cases
select the corresponding variables with allow- and deny-lists and with an optional prefix and optional custom separator for nested variables. The variable names are
either inferred from the config name or can be explicitly mapped.
- :class:`~confz.ConfZCLArgSource` allows to load config data from command line arguments. An optional prefix allows
to select only parts of the arguments. Optional custom separator for nested variables is also supported. The argument names are either inferred from the config name or can be
to select only parts of the arguments. Optional custom separator for nested command line arguments is also supported. The argument names are either inferred from the config name or can be
explicitly mapped.
- :class:`~confz.ConfZDataSource` allows to define constant config data. This can be very useful for unit tests, see
:ref:`context_manager`.
Expand Down

0 comments on commit a374040

Please sign in to comment.