Skip to content

dependency-groups cross link Added in Pyproject.toml page #1847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Daksh2000
Copy link

@Daksh2000 Daksh2000 commented Apr 14, 2025

@Daksh2000 Daksh2000 changed the title dependency-groups specification cross link Added dependency-groups specification cross link Added in Pyproject.toml page Apr 14, 2025
@Daksh2000 Daksh2000 changed the title dependency-groups specification cross link Added in Pyproject.toml page dependency-groups cross link Added in Pyproject.toml page Apr 14, 2025
@webknjaz webknjaz requested a review from ncoghlan April 14, 2025 20:31
Copy link
Member

@ncoghlan ncoghlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inline suggestion to streamline a couple of the paragraphs, but this generally looks good to me. Thanks!

@webknjaz webknjaz requested a review from ncoghlan May 30, 2025 12:01
Copy link
Member

@ncoghlan ncoghlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks!

@webknjaz
Copy link
Member

webknjaz commented Jun 1, 2025

The CI didn't run because the last commit coincided w/ GH outage. I clicked "rebase" to trigger it.

@Daksh2000
Copy link
Author

The CI didn't run because the last commit coincided w/ GH outage. I clicked "rebase" to trigger it.

Hi , I could update the branch again if thats alright ?

@webknjaz
Copy link
Member

webknjaz commented Jun 1, 2025

You could. But the CI failure look unrelated to your PR and should be fixed in a separate one.

Since rebasing force-pushed the branch in your fork, it's best for you to git pull --rebase locally so Git wouldn't create a merge commit when you sync.

That said, the CI failure is not a reason for you to touch the branch. We just have to wait for the link fix. You can send a PR for that yourself, if you want.

@Daksh2000
Copy link
Author

You could. But the CI failure look unrelated to your PR and should be fixed in a separate one.

Since rebasing force-pushed the branch in your fork, it's best for you to git pull --rebase locally so Git wouldn't create a merge commit when you sync.

That said, the CI failure is not a reason for you to touch the branch. We just have to wait for the link fix. You can send a PR for that yourself, if you want.

Hi, Created a PR - #1868

==============================================================

This specification defines Dependency Groups, a mechanism for storing package requirements in
``[pyproject.toml]`` files such that they are not included in project metadata when it is built.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accidental brackets in the file name?

Suggested change
``[pyproject.toml]`` files such that they are not included in project metadata when it is built.
:file:`pyproject.toml` files such that they are not included in project metadata when it is built.

@@ -16,13 +16,15 @@ tools (as well as other tools).

.. note:: This specification was originally defined in :pep:`518` and :pep:`621`.

The ``pyproject.toml`` file is written in `TOML <https://toml.io>`_. Three
The ``pyproject.toml`` file is written in `TOML <https://toml.io>`_. Several
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The ``pyproject.toml`` file is written in `TOML <https://toml.io>`_. Several
The :file:`pyproject.toml` file is written in `TOML <https://toml.io>`_. Several

The ``[dependency-groups]`` table is an optional top-level table that allows defining non-distribution dependencies used for internal tooling, such as testing or linting.
Dependency groups are also suitable for use in projects which are not built for distribution, such as collections of related scripts.

For the full specification and behavior, refer to the `Dependency Groups specification <https://packaging.python.org/en/latest/specifications/dependency-groups/>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be an absolute URL but rather a Sphinx-recognized RST reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing dependency-groups specification cross link
5 participants