steffo/cfig
steffo/cfig
1
Fork 0
mirror of https://github.com/Steffo99/cfig.git synced 2024-11-21 07:24:21 +00:00
Code Activity

Be more specific in the return doc for resolve and resolve_failfast

Browse source
This commit is contained in:
Steffo 2022-09-05 23:01:25 +02:00
parent 44f936e507
commit 8a7eadf4ae
Signed by: steffo
GPG key ID: 6965406171929D01
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
cfig/config.py
View file

@ -39,7 +39,7 @@ class Configuration:
Resolve all values of the proxies inside this dictionary.
:raises .errors.BatchResolutionFailure: If it was not possible to resolve at least one value.
:returns: A :class:`dict` containing all the resolved values.
:returns: A :class:`dict` containing all the resolved, unproxied, values.
"""
errors_dict = {}
@ -65,7 +65,7 @@ class Configuration:
Resolve all values of the proxies inside this dictionary, failing immediately if an error occurs during a resolution, and raising the error itself.
:raises Exception: The error occurred during the resolution.
:returns: A :class:`dict` containing all the resolved values.
:returns: A :class:`dict` containing all the resolved, unproxied, values.
"""
result_dict = {}

2
docs/advanced.rst
View file

@ -107,3 +107,5 @@ If the provided sources aren't enough, you may create a custom class inheriting
.. hint::
Since :mod:`cfig.sources` is a namespace package, if you intend to distribute your custom source, you may want to do it by extending the namespace, for an easier developer workflow.