Skip to content

pyproject.toml example in README uses deprecated fields #10477

@KUHLwasStolen

Description

@KUHLwasStolen

Issue Kind

Improving documentation

Existing Link

https://github.com/python-poetry/poetry/blob/main/README.md

Description

According to this section of the documentation the pyproject.toml example in the README is deprecated or different practices are suggested now.

In particular the following fields are "Deprecated: Use project.[...] instead."

  • name
  • description
  • license
  • authors
  • repository
  • homepage
  • keywords

Additionally, "If you do not want to set the version dynamically via poetry build --local-version and you are not using a plugin, which sets the version dynamically, prefer project.version over this setting."
Which should also be the case here.

Fixing this should be quite simple when sticking to the documentation's suggestions and I will create a pull request if no one objects to my interpretation of the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsDocumentation issues/improvementsstatus/triageThis issue needs to be triaged

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions