Skip to content

Clarify that name and version fields are required in non-package mode if [project] is used #10033

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

Merged
abn merged 1 commit into from
Jan 14, 2025
+3 −2
Merged

Clarify that name and version fields are required in non-package mode if [project] is used #10033

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions docs/pyproject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ menu:
In package mode, the only required fields are `name` and `version`
(either in the `project` section or in the `tool.poetry` section).
Other fields are optional.
In non-package mode, all fields are optional.
In non-package mode, the `name` and `version` fields are required
if using the `project` section.

{{% note %}}
Run `poetry check` to print warnings about deprecated fields.
Expand All @@ -39,7 +40,7 @@ name = "my-package"

### version

The version of the package. **Required in package mode**
The version of the package. **Always required when the `project` section is specified**

This should be a valid [PEP 440](https://peps.python.org/pep-0440/) string.

Expand Down
Loading