From 0825d608e6e03a1789cbf69112bf35b39b037fa0 Mon Sep 17 00:00:00 2001 From: David Wobrock Date: Fri, 22 Sep 2023 09:22:38 +0200 Subject: [PATCH] Document in CHANGELOG the behaviour change of interpolate. --- CHANGELOG.rst | 4 ++++ docs/tips.rst | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3e664260..89f4f86b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -11,6 +11,10 @@ Added +++++ - Added support for ``interpolate`` parameter `#495 `_. + This implies a breaking change on the ``interpolate`` parameter. + Before this change, ``Env(interpolate=True)`` and ``Env(interpolate=False)`` had the same + behaviour. After the change, ``Env(interpolate=False)`` won't substitute values anymore + that start with ``$``. `v0.11.2`_ - 1-September-2023 diff --git a/docs/tips.rst b/docs/tips.rst index ab59f691..c9b063bb 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -225,7 +225,7 @@ The following example demonstrates the above: Proxy value =========== -Values that being with a ``$`` may be interpolated. Pass ``interpolate=True`` to +Values that begin with a ``$`` may be interpolated. Pass ``interpolate=True`` to ``environ.Env()`` to enable this feature (``True`` by default): .. code-block:: python