Document in CHANGELOG the behaviour change of interpolate.

joke2k · Sep 22, 2023 · 0825d60 · 0825d60
1 parent 407928e
commit 0825d60
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -11,6 +11,10 @@ Added
 +++++
 - Added support for ``interpolate`` parameter
  `#495 <https://github.com/joke2k/django-environ/pull/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
@@ -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