From 8a7eadf4ae1c1a1fe6d926273116ed1297ed8f13 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Mon, 5 Sep 2022 23:01:25 +0200 Subject: [PATCH] Be more specific in the return doc for `resolve` and `resolve_failfast` --- cfig/config.py | 4 ++-- docs/advanced.rst | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/cfig/config.py b/cfig/config.py index a695ebc..c06c4ad 100644 --- a/cfig/config.py +++ b/cfig/config.py @@ -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 = {} diff --git a/docs/advanced.rst b/docs/advanced.rst index c2a48d3..e55105f 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -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. + +