Add docs for escape proxy feature

Signed-off-by: Mehdy Khoshnoody <mehdy.khoshnoody@gmail.com>
joke2k · Oct 7, 2021 · 1b6c4ba · 1b6c4ba
1 parent af4c68d
commit 1b6c4ba
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/docs/tips.rst b/docs/tips.rst
@@ -195,6 +195,23 @@ Values that being with a ``$`` may be interpolated. Pass ``interpolate=True`` to
    FOO
 
 
+Escape Proxy
+============
+
+If you're having trouble with values starting with dollar sign ($) without the intention of proxying the value to
+another, You should enbale the ``escape_proxy`` and prepend a backslash to it.
+
+.. code-block:: python
+
+    import environ
+
+    env = environ.Env()
+    env.escape_proxy = True
+
+    # ESCAPED_VAR=\$baz
+    env.str('ESCAPED_VAR')  # $baz
+
+
 Reading env files
 =================