Improve plugin list disclaimer (#11397)

Closes #11391
This commit is contained in:
Stefaan Lippens 2023-09-06 12:34:38 +02:00 committed by GitHub
parent faa8f2ea08
commit 3ce63bc768
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 36 additions and 10 deletions

View File

@ -348,6 +348,7 @@ Simon Holesch
Simon Kerr Simon Kerr
Skylar Downes Skylar Downes
Srinivas Reddy Thatiparthy Srinivas Reddy Thatiparthy
Stefaan Lippens
Stefan Farmbauer Stefan Farmbauer
Stefan Scherfke Stefan Scherfke
Stefan Zimmermann Stefan Zimmermann

1
changelog/11391.doc.rst Normal file
View File

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

View File

@ -3,14 +3,26 @@
.. _plugin-list: .. _plugin-list:
Plugin List Pytest Plugin List
=========== ==================
PyPI projects that match "pytest-\*" are considered plugins and are listed Below is an automated compilation of ``pytest``` plugins available on `PyPI <https://pypi.org>`_.
automatically together with a manually-maintained list in `the source It includes PyPI projects whose names begin with "pytest-" and a handful of manually selected projects.
code <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
Packages classified as inactive are excluded. Packages classified as inactive are excluded.
For detailed insights into how this list is generated,
please refer to `the update script <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
.. warning::
Please be aware that this list is not a curated collection of projects
and does not undergo a systematic review process.
It serves purely as an informational resource to aid in the discovery of ``pytest`` plugins.
Do not presume any endorsement from the ``pytest`` project or its developers,
and always conduct your own quality assessment before incorporating any of these plugins into your own projects.
.. The following conditional uses a different format for this list when .. The following conditional uses a different format for this list when
creating a PDF, because otherwise the table gets far too wide for the creating a PDF, because otherwise the table gets far too wide for the
page. page.

View File

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