Browse Source

Fix docstring for Wikicode.strip_code().

tags/v0.3.3
Ben Kurtovic 10 years ago
parent
commit
454890ab0d
1 changed files with 5 additions and 5 deletions
  1. +5
    -5
      mwparserfromhell/wikicode.py

+ 5
- 5
mwparserfromhell/wikicode.py View File

@@ -527,11 +527,11 @@ class Wikicode(StringMixIn):
"""Return a rendered string without unprintable code such as templates.

The way a node is stripped is handled by the
:py:meth:`~.Node.__showtree__` method of :py:class:`~.Node` objects,
which generally return a subset of their nodes or ``None``. For
example, templates and tags are removed completely, links are stripped
to just their display part, headings are stripped to just their title.
If *normalize* is ``True``, various things may be done to strip code
:py:meth:`~.Node.__strip__` method of :py:class:`~.Node` objects, which
generally return a subset of their nodes or ``None``. For example,
templates and tags are removed completely, links are stripped to just
their display part, headings are stripped to just their title. If
*normalize* is ``True``, various things may be done to strip code
further, such as converting HTML entities like ``Σ``, ``Σ``,
and ``Σ`` to ``Σ``. If *collapse* is ``True``, we will try to
remove excess whitespace as well (three or more newlines are converted


Loading…
Cancel
Save