Browse Source

Some doc updates.

tags/v0.3
Ben Kurtovic 11 years ago
parent
commit
bee74c0ced
5 changed files with 11 additions and 5 deletions
  1. +1
    -0
      CHANGELOG
  2. +1
    -1
      README.rst
  3. +2
    -0
      docs/changelog.rst
  4. +5
    -2
      docs/index.rst
  5. +2
    -2
      mwparserfromhell/nodes/tag.py

+ 1
- 0
CHANGELOG View File

@@ -1,5 +1,6 @@
v0.3 (unreleased): v0.3 (unreleased):


- Added complete support for HTML Tags, along with appropriate unit tests.
- Various fixes and cleanup. - Various fixes and cleanup.


v0.2 (released June 20, 2013): v0.2 (released June 20, 2013):


+ 1
- 1
README.rst View File

@@ -19,7 +19,7 @@ The easiest way to install the parser is through the `Python Package Index`_,
so you can install the latest release with ``pip install mwparserfromhell`` so you can install the latest release with ``pip install mwparserfromhell``
(`get pip`_). Alternatively, get the latest development version:: (`get pip`_). Alternatively, get the latest development version::


git clone git://github.com/earwig/mwparserfromhell.git
git clone https://github.com/earwig/mwparserfromhell.git
cd mwparserfromhell cd mwparserfromhell
python setup.py install python setup.py install




+ 2
- 0
docs/changelog.rst View File

@@ -7,6 +7,8 @@ v0.3
Unreleased Unreleased
(`changes <https://github.com/earwig/mwparserfromhell/compare/v0.2...develop>`__): (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.2...develop>`__):


- Added complete support for HTML :py:class:`Tags <.Tag>`, along with
appropriate unit tests.
- Various fixes and cleanup. - Various fixes and cleanup.


v0.2 v0.2


+ 5
- 2
docs/index.rst View File

@@ -5,11 +5,14 @@ MWParserFromHell v\ |version| Documentation
package that provides an easy-to-use and outrageously powerful parser for package that provides an easy-to-use and outrageously powerful parser for
MediaWiki_ wikicode. It supports Python 2 and Python 3. MediaWiki_ wikicode. It supports Python 2 and Python 3.


Developed by Earwig_ with help from `Σ`_.
Developed by Earwig_ with contributions from `Σ`_, Legoktm_, and others.
Development occurs on GitHub_.


.. _MediaWiki: http://mediawiki.org .. _MediaWiki: http://mediawiki.org
.. _Earwig: http://en.wikipedia.org/wiki/User:The_Earwig .. _Earwig: http://en.wikipedia.org/wiki/User:The_Earwig
.. _Σ: http://en.wikipedia.org/wiki/User:%CE%A3 .. _Σ: http://en.wikipedia.org/wiki/User:%CE%A3
.. _Legoktm: http://en.wikipedia.org/wiki/User:Legoktm
.. _GitHub: https://github.com/earwig/mwparserfromhell


Installation Installation
------------ ------------
@@ -18,7 +21,7 @@ The easiest way to install the parser is through the `Python Package Index`_,
so you can install the latest release with ``pip install mwparserfromhell`` so you can install the latest release with ``pip install mwparserfromhell``
(`get pip`_). Alternatively, get the latest development version:: (`get pip`_). Alternatively, get the latest development version::


git clone git://github.com/earwig/mwparserfromhell.git
git clone https://github.com/earwig/mwparserfromhell.git
cd mwparserfromhell cd mwparserfromhell
python setup.py install python setup.py install




+ 2
- 2
mwparserfromhell/nodes/tag.py View File

@@ -144,7 +144,7 @@ class Tag(Node):
This makes the tag look like a lone close tag. It is technically This makes the tag look like a lone close tag. It is technically
invalid and is only parsable Wikicode when the tag itself is invalid and is only parsable Wikicode when the tag itself is
single-only, like ``<br>`` and ``<img>``. See single-only, like ``<br>`` and ``<img>``. See
:py:func:`tag_defs.is_single_only`.
:py:func:`.tag_defs.is_single_only`.
""" """
return self._invalid return self._invalid


@@ -153,7 +153,7 @@ class Tag(Node):
"""Whether the tag is implicitly self-closing, with no ending slash. """Whether the tag is implicitly self-closing, with no ending slash.


This is only possible for specific "single" tags like ``<br>`` and This is only possible for specific "single" tags like ``<br>`` and
``<li>``. See :py:func:`tag_defs.is_single`. This field only has an
``<li>``. See :py:func:`.tag_defs.is_single`. This field only has an
effect if :py:attr:`self_closing` is also ``True``. effect if :py:attr:`self_closing` is also ``True``.
""" """
return self._implicit return self._implicit


Loading…
Cancel
Save