Skip to content

Commit 39243d0

Browse files
committed
DOC: minor docs cleanup
1 parent d671de0 commit 39243d0

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,10 @@ pytest-doctestplus
1111
:alt: CI Status
1212

1313
This package contains a plugin for the `pytest`_ framework that provides
14-
advanced doctest support and enables the testing of `reStructuredText`_
15-
(".rst") files. It was originally part of the `astropy`_ core package, but has
16-
been moved to a separate package in order to be of more general use.
14+
advanced doctest support and enables the testing of various text files, such
15+
as reStructuredText (".rst"), markdown (".md"), and TeX (".tex").
1716

1817
.. _pytest: https://pytest.org/en/latest/
19-
.. _astropy: https://astropy.org/
20-
.. _reStructuredText: https://en.wikipedia.org/wiki/ReStructuredText
2118

2219

2320
Motivation
@@ -44,7 +41,6 @@ providing the following features:
4441
* optional inclusion of ``*.rst`` files for doctests (see `Setup and Configuration`_)
4542
* optional inclusion of doctests in docstrings of Numpy ufuncs
4643

47-
.. _pytest-remotedata: https://github.com/astropy/pytest-remotedata
4844

4945
Installation
5046
------------
@@ -331,7 +327,7 @@ marked:
331327
.. code-block:: python
332328
333329
>>> from urlib.request import urlopen
334-
>>> url = urlopen('http://astropy.org') # doctest: +REMOTE_DATA
330+
>>> url = urlopen('http://astropy.org') # doctest: +REMOTE_DATA
335331
336332
The ``+REMOTE_DATA`` directive indicates that the marked statement should only
337333
be executed if the ``--remote-data`` option is given. By default, all

0 commit comments

Comments
 (0)