summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeonard Richardson <leonardr@segfault.org>2020-03-06 06:57:43 -0500
committerLeonard Richardson <leonardr@segfault.org>2020-03-06 06:57:43 -0500
commit180b6fddd104eea276a92806e6d44962a37093fa (patch)
treee31674d51b1bf5d989d28618fa92c44a30838d52
parentd35d70fc9a05252295110b9d7cd2eac5afce4a7c (diff)
Added a paragraph about the fact that prettify() adds whitespace to a document.
-rw-r--r--doc/source/index.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index c693ff0..c880c2e 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -2215,6 +2215,11 @@ or on any of its ``Tag`` objects::
# </i>
# </a>
+Since it adds whitespace (in the form of newlines), ``prettify()``
+changes the meaning of an HTML document and should not be used to
+reformat one. The goal of ``prettify()`` is to help you visually
+understand the structure of the documents you work with.
+
Non-pretty printing
-------------------