8000 Update testing docs (#14561) · matplotlib/matplotlib@569204b · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 569204b

Browse files
authored
Update testing docs (#14561)
Update testing docs
2 parents 6d6861b + 9357cca commit 569204b

File tree

2 files changed

+14
-21
lines changed

2 files changed

+14
-21
lines changed

doc/devel/testing.rst

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ infrastructure are in :mod:`matplotlib.testing`.
1212
.. _Ghostscript: https://www.ghostscript.com/
1313
.. _Inkscape: https://inkscape.org
1414
.. _pytest-cov: https://pytest-cov.readthedocs.io/en/latest/
15-
.. _pytest-pep8: https://pypi.python.org/pypi/pytest-pep8
16-
.. _pytest-xdist: https://pypi.python.org/pypi/pytest-xdist
17-
.. _pytest-timeout: https://pypi.python.org/pypi/pytest-timeout
15+
.. _pytest-flake8: https://pypi.org/project/pytest-flake8/
16+
.. _pytest-xdist: https://pypi.org/project/pytest-xdist/
17+
.. _pytest-timeout: https://pypi.org/project/pytest-timeout/
18+
.. _flake8: https://pypi.org/project/flake8/
1819

1920
Requirements
2021
------------
@@ -32,7 +33,7 @@ The following software is required to run the tests:
3233
Optionally you can install:
3334

3435
- pytest-cov_ (>=2.3.1) to collect coverage information
35-
- pytest-pep8_ to test coding standards
36+
- pytest-flake8_ to test coding standards using flake8_
3637
- pytest-timeout_ to limit runtime in case of stuck tests
3738
- pytest-xdist_ to run tests in parallel
3839

@@ -44,28 +45,20 @@ Running the tests is simple. Make sure you have pytest installed and run::
4445

4546
pytest
4647

47-
or::
48+
in the root directory of the repository.
4849

49-
pytest .
50-
51-
52-
in the root directory of the distribution. The script takes a set of
53-
commands, such as:
54-
55-
======================== ===========
56-
``--pep8`` Perform pep8 checks (requires pytest-pep8_)
57-
======================== ===========
58-
59-
Additional arguments are passed on to pytest. See the pytest documentation for
60-
`supported arguments`_. Some of the more important ones are given here:
50+
`pytest` can be configured via a lot of `commandline parameters`_. Some
51+
particularly useful ones are:
6152

6253
============================= ===========
63-
``--verbose`` Be more verbose
64-
``--n NUM`` Run tests in parallel over NUM
54+
``-v`` or ``--verbose`` Be more verbose
55+
``-n NUM`` Run tests in parallel over NUM
6556
processes (requires pytest-xdist_)
6657
``--timeout=SECONDS`` Set timeout for results from each test
6758
process (requires pytest-timeout_)
6859
``--capture=no`` or ``-s`` Do not capture stdout
60+
``--flake8`` Check coding standards using flake8_
61+
(requires pytest-flake8_)
6962
============================= ===========
7063

7164
To run a single test from the command line, you can provide a file path,
@@ -97,7 +90,7 @@ function :func:`matplotlib.test`::
9790
matplotlib.test()
9891

9992

100-
.. _supported arguments: http://doc.pytest.org/en/latest/usage.html
93+
.. _commandline parameters: http://doc.pytest.org/en/latest/usage.html
10194

10295

10396
Writing a simple test

doc/thirdpartypackages/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class that can have a visual break to indicate a discontinuous range.
9090
DeCiDa
9191
======
9292

93-
`DeCiDa <https://pypi.python.org/pypi/DeCiDa>`_ is a library of functions
93+
`DeCiDa <https://pypi.org/project/DeCiDa/>`_ is a library of functions
9494
and classes for electron device characterization, electronic circuit design and
9595
general data visualization and analysis.
9696

0 commit comments

Comments
 (0)
0