Skip to content
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.

Sign up for GitHub

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

Clarifies the dev-dependencies -> group.dev.dependencies switch in docs #6723

Merged
merged 2 commits into from
Nov 6, 2022
Merged

Clarifies the dev-dependencies -> group.dev.dependencies switch in docs #6723

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9ab928
Clarifies the dev-dependencies -> group.dev.dependencies switch
colindean Oct 6, 2022
1485787
Use 1.2.0 instead of 1.2.x
colindean Nov 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/managing-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,24 @@ use [extras]({{< relref "pyproject#extras" >}}) instead. Extras can be installed
{{% /note %}}

{{% note %}}
**A note about the `dev-dependencies` section**
**A note about defining a `dev` dependencies group**

Any dependency declared in the `dev-dependencies` section will automatically be added to a `dev` group.
So the two following notations are equivalent:
The proper way to define a `dev` dependencies group since Poetry 1.2.0 is the following:

```toml
[tool.poetry.dev-dependencies]
[tool.poetry.group.dev.dependencies]
pytest = "^6.0.0"
pytest-mock = "*"
```

This group notation is preferred since Poetry 1.2.0 and not usable in earlier versions.
For backwards compatibility with older versions of Poetry,
any dependency declared in the `dev-dependencies` section will automatically be added to the `dev` group.
So the above and following notations are equivalent:

```toml
[tool.poetry.group.dev.dependencies]
# Poetry pre-1.2.x style, understood by Poetry 1.0–1.2
[tool.poetry.dev-dependencies]
pytest = "^6.0.0"
pytest-mock = "*"
```
Expand Down