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.

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

Unclear description of "readme" field in pyproject.toml #196

Closed
thomasbbrunner opened this issue Aug 26, 2023 · 2 comments
Closed

Unclear description of "readme" field in pyproject.toml #196

thomasbbrunner opened this issue Aug 26, 2023 · 2 comments

Comments

@thomasbbrunner
Copy link
Contributor

thomasbbrunner commented Aug 26, 2023

The readme field of the pyproject.toml contains the following description:

# This is an optional longer description of your project that represents
# the body of text which users will see when they visit PyPI.
#
# Often, this is the same as your README, so you can just read it in from
# that file directly **(as we have already done above)**
# (...)
readme = "README.md" # Optional

What exactly does the highlighted part mean ("as we have already done above")? Above where?

Also, if the readme value is set to README.md, does it mean that the file is loaded? If so, could we make it explicit here?

@thomasbbrunner
Copy link
Contributor Author

After a more thorough reading of the pyproject.toml file, apparently the order of the fields in the file was changed but the text was not updated.

I've created a minor PR with updates.

@chrysle
Copy link
Contributor

chrysle commented Mar 18, 2024

Can this be closed, then?

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

No branches or pull requests

2 participants