clarify escape() description: key point is literal rendering

jec5000 · Sep 18, 2019 · 95c7fa4 · 95c7fa4
1 parent 350e6b7
commit 95c7fa4
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/manual.rst b/docs/manual.rst
@@ -289,8 +289,9 @@ instead (same solution as proposed for the stdlib :mod:`re` module):
 .. image:: _static/escapes.svg
     :align: center
 
-To disable any special character meaning in a string (e.g. from an untrusted
-source), use the :func:`.escape` function (cf. the :func:`re.escape` function):
+To disable any special character meaning in a string (e.g. from user input to
+be rendered literally), use the :func:`.escape` function (cf. the
+:func:`re.escape` function):
 
 .. code:: python