Skip to content

Commit de69883

Browse files
[7.4.x] improve plugin list disclaimer (#11398)
Co-authored-by: Stefaan Lippens <soxofaan@users.noreply.github.com>
1 parent 1de00e9 commit de69883

File tree

4 files changed

+36
-10
lines changed

4 files changed

+36
-10
lines changed

AUTHORS

+1
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,7 @@ Simon Holesch
341341
Simon Kerr
342342
Skylar Downes
343343
Srinivas Reddy Thatiparthy
344+
Stefaan Lippens
344345
Stefan Farmbauer
345346
Stefan Scherfke
346347
Stefan Zimmermann

changelog/11391.doc.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Improved disclaimer on pytest plugin reference page to better indicate this is an automated, non-curated listing.

doc/en/reference/plugin_list.rst

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11

22
.. _plugin-list:
33

4-
Plugin List
5-
===========
4+
Pytest Plugin List
5+
==================
66

7-
PyPI projects that match "pytest-\*" are considered plugins and are listed
8-
automatically together with a manually-maintained list in `the source
9-
code <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
7+
Below is an automated compilation of ``pytest``` plugins available on `PyPI <https://pypi.org>`_.
8+
It includes PyPI projects whose names begin with "pytest-" and a handful of manually selected projects.
109
Packages classified as inactive are excluded.
1110

11+
For detailed insights into how this list is generated,
12+
please refer to `the update script <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
13+
14+
.. warning::
15+
16+
Please be aware that this list is not a curated collection of projects
17+
and does not undergo a systematic review process.
18+
It serves purely as an informational resource to aid in the discovery of ``pytest`` plugins.
19+
20+
Do not presume any endorsement from the ``pytest`` project or its developers,
21+
and always conduct your own quality assessment before incorporating any of these plugins into your own projects.
22+
23+
1224
.. The following conditional uses a different format for this list when
1325
creating a PDF, because otherwise the table gets far too wide for the
1426
page.

scripts/update-plugin-list.py

+17-5
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,26 @@
1313
FILE_HEAD = r"""
1414
.. _plugin-list:
1515
16-
Plugin List
17-
===========
16+
Pytest Plugin List
17+
==================
1818
19-
PyPI projects that match "pytest-\*" are considered plugins and are listed
20-
automatically together with a manually-maintained list in `the source
21-
code <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
19+
Below is an automated compilation of ``pytest``` plugins available on `PyPI <https://pypi.org>`_.
20+
It includes PyPI projects whose names begin with "pytest-" and a handful of manually selected projects.
2221
Packages classified as inactive are excluded.
2322
23+
For detailed insights into how this list is generated,
24+
please refer to `the update script <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
25+
26+
.. warning::
27+
28+
Please be aware that this list is not a curated collection of projects
29+
and does not undergo a systematic review process.
30+
It serves purely as an informational resource to aid in the discovery of ``pytest`` plugins.
31+
32+
Do not presume any endorsement from the ``pytest`` project or its developers,
33+
and always conduct your own quality assessment before incorporating any of these plugins into your own projects.
34+
35+
2436
.. The following conditional uses a different format for this list when
2537
creating a PDF, because otherwise the table gets far too wide for the
2638
page.

0 commit comments

Comments
 (0)