Skip to content

Commit 207f321

Browse files
committed
Update module name in the documentation
1 parent 50be1ff commit 207f321

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

USAGE.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Cleaning up HTML
22
================
33

4-
The module ``lxml.html.clean`` provides a ``Cleaner`` class for cleaning up
4+
The module ``lxml_html_clean`` provides a ``Cleaner`` class for cleaning up
55
HTML pages. It supports removing embedded or script content, special tags,
66
CSS style annotations and much more.
77

8-
Note: the HTML Cleaner in ``lxml.html.clean`` is **not** considered
8+
Note: the HTML Cleaner in ``lxml_html_clean`` is **not** considered
99
appropriate **for security sensitive environments**.
1010
See e.g. `bleach <https://pypi.org/project/bleach/>`_ for an alternative.
1111

@@ -47,7 +47,7 @@ To remove the all superfluous content from this unparsed document, use the
4747

4848
.. sourcecode:: pycon
4949

50-
>>> from lxml.html.clean import clean_html
50+
>>> from lxml_html_clean import clean_html
5151
>>> print clean_html(html)
5252
<div><style>/* deleted */</style><body>
5353

@@ -67,7 +67,7 @@ which content is removed:
6767

6868
.. sourcecode:: pycon
6969

70-
>>> from lxml.html.clean import Cleaner
70+
>>> from lxml_html_clean import Cleaner
7171

7272
>>> cleaner = Cleaner(page_structure=False, links=False)
7373
>>> print cleaner.clean_html(html)
@@ -121,7 +121,7 @@ cleaned.
121121
autolink
122122
--------
123123

124-
In addition to cleaning up malicious HTML, ``lxml.html.clean``
124+
In addition to cleaning up malicious HTML, ``lxml_html_clean``
125125
contains functions to do other things to your HTML. This includes
126126
autolinking::
127127

0 commit comments

Comments
 (0)