From 3ce63bc76874b6b60377c8f001ceb03ed5c2f34f Mon Sep 17 00:00:00 2001 From: Stefaan Lippens Date: Wed, 6 Sep 2023 12:34:38 +0200 Subject: [PATCH] Improve plugin list disclaimer (#11397) Closes #11391 --- AUTHORS | 1 + changelog/11391.doc.rst | 1 + doc/en/reference/plugin_list.rst | 22 +++++++++++++++++----- scripts/update-plugin-list.py | 22 +++++++++++++++++----- 4 files changed, 36 insertions(+), 10 deletions(-) create mode 100644 changelog/11391.doc.rst diff --git a/AUTHORS b/AUTHORS index 52157cc0a..b6bc02988 100644 --- a/AUTHORS +++ b/AUTHORS @@ -348,6 +348,7 @@ Simon Holesch Simon Kerr Skylar Downes Srinivas Reddy Thatiparthy +Stefaan Lippens Stefan Farmbauer Stefan Scherfke Stefan Zimmermann diff --git a/changelog/11391.doc.rst b/changelog/11391.doc.rst new file mode 100644 index 000000000..fff324af1 --- /dev/null +++ b/changelog/11391.doc.rst @@ -0,0 +1 @@ +Improved disclaimer on pytest plugin reference page to better indicate this is an automated, non-curated listing. diff --git a/doc/en/reference/plugin_list.rst b/doc/en/reference/plugin_list.rst index 7dae208a0..68eaf69ea 100644 --- a/doc/en/reference/plugin_list.rst +++ b/doc/en/reference/plugin_list.rst @@ -3,14 +3,26 @@ .. _plugin-list: -Plugin List -=========== +Pytest Plugin List +================== -PyPI projects that match "pytest-\*" are considered plugins and are listed -automatically together with a manually-maintained list in `the source -code `_. +Below is an automated compilation of ``pytest``` plugins available on `PyPI `_. +It includes PyPI projects whose names begin with "pytest-" and a handful of manually selected projects. Packages classified as inactive are excluded. +For detailed insights into how this list is generated, +please refer to `the update script `_. + +.. 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 creating a PDF, because otherwise the table gets far too wide for the page. diff --git a/scripts/update-plugin-list.py b/scripts/update-plugin-list.py index f345e1f7c..c5f918724 100644 --- a/scripts/update-plugin-list.py +++ b/scripts/update-plugin-list.py @@ -20,14 +20,26 @@ FILE_HEAD = r""" .. _plugin-list: -Plugin List -=========== +Pytest Plugin List +================== -PyPI projects that match "pytest-\*" are considered plugins and are listed -automatically together with a manually-maintained list in `the source -code `_. +Below is an automated compilation of ``pytest``` plugins available on `PyPI `_. +It includes PyPI projects whose names begin with "pytest-" and a handful of manually selected projects. Packages classified as inactive are excluded. +For detailed insights into how this list is generated, +please refer to `the update script `_. + +.. 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 creating a PDF, because otherwise the table gets far too wide for the page.