From 5916cc9814ed16cf6c963da08c5eb0ec01872495 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= Date: Mon, 21 Oct 2024 22:38:10 -0700 Subject: [PATCH] Fix example docs (#3421) --- .pre-commit-config.yaml | 4 ++++ docs/changelog/3240.doc.rst | 1 + docs/config.rst | 4 ++-- docs/index.rst | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 docs/changelog/3240.doc.rst diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70abc6ef48..30f0c86dac 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,6 +18,10 @@ repos: rev: "2.4.3" hooks: - id: pyproject-fmt + - repo: https://github.com/abravalheri/validate-pyproject + rev: "v0.21" + hooks: + - id: validate-pyproject - repo: https://github.com/astral-sh/ruff-pre-commit rev: "v0.7.0" hooks: diff --git a/docs/changelog/3240.doc.rst b/docs/changelog/3240.doc.rst new file mode 100644 index 0000000000..751e1aa0ab --- /dev/null +++ b/docs/changelog/3240.doc.rst @@ -0,0 +1 @@ +Fix bad example in documentation for dependency groups - by :user:`gaborbernat`. diff --git a/docs/config.rst b/docs/config.rst index 9df1eae798..b1bb25ac47 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -839,13 +839,13 @@ Python run .. code-block:: toml - [dependency_groups] + [dependency-groups] test = [ "pytest>=8", ] [tool.tox.env_run_base] - dependency-groups = [ + dependency_groups = [ "test", ] diff --git a/docs/index.rst b/docs/index.rst index f4222031e5..d58b9fd991 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,7 +22,7 @@ and `devpi `_). :target: https://pypistats.org/packages/tox :alt: PyPI - Downloads .. image:: https://img.shields.io/pypi/l/tox?style=flat-square - :target: https://opensource.org/blog/license/mit + :target: https://opensource.org/license/mit :alt: PyPI - License .. image:: https://img.shields.io/github/issues/tox-dev/tox?style=flat-square :target: https://github.com/tox-dev/tox/issues