Skip to content

Commit 3ce63bc

Browse files
authored
Improve plugin list disclaimer (#11397)
Closes #11391
1 parent faa8f2e commit 3ce63bc

File tree

4 files changed

+36
-10
lines changed

4 files changed

+36
-10
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,7 @@ Simon Holesch
348348
Simon Kerr
349349
Skylar Downes
350350
Srinivas Reddy Thatiparthy
351+
Stefaan Lippens
351352
Stefan Farmbauer
352353
Stefan Scherfke
353354
Stefan Zimmermann

changelog/11391.doc.rst

Lines changed: 1 addition & 0 deletions
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

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,26 @@
33

44
.. _plugin-list:
55

6-
Plugin List
7-
===========
6+
Pytest Plugin List
7+
==================
88

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

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

scripts/update-plugin-list.py

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

0 commit comments

Comments
 (0)