Skip to content

Commit 1e1e272

Browse files
johnthagenabn
authored andcommitted
Clarify that name and version fields are required in non-package mode if [project] is used
1 parent 88b2bab commit 1e1e272

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/pyproject.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ menu:
1414
In package mode, the only required fields are `name` and `version`
1515
(either in the `project` section or in the `tool.poetry` section).
1616
Other fields are optional.
17-
In non-package mode, all fields are optional.
17+
In non-package mode, the `name` and `version` fields are required
18+
if using the `project` section.
1819

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

4041
### version
4142

42-
The version of the package. **Required in package mode**
43+
The version of the package. **Always required when the `project` section is specified**
4344

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

0 commit comments

Comments
 (0)