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

Fixes inconsistencies in pyproject.toml documentation. #197

Merged
merged 3 commits into from
Feb 29, 2024

Conversation

thomasbbrunner
Copy link
Contributor

@thomasbbrunner thomasbbrunner commented Aug 26, 2023

Addresses inconsistencies of the documentation of fields in the pyproject.toml file.

Related to #196.

@JonasLoos
Copy link

JonasLoos commented Oct 11, 2023

Specifying readme = {file = "README.md"} seems to be wrong, according to https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#readme. I also got an error when trying it out locally.

Valid options are:

readme = "README.md"  # as previously

or

readme = {file = "README.md", content-type = "text/markdown"}

@thomasbbrunner
Copy link
Contributor Author

thomasbbrunner commented Oct 30, 2023

True, somehow I missed this. Thanks for taking the time and reporting this!

I'll update the MR, even though there does not seem to be much interest in merging this.

@thomasbbrunner thomasbbrunner changed the title Minor improvements to pyproject.toml documentation. Fixes inconsistencies in pyproject.toml documentation. Oct 30, 2023
@thomasbbrunner
Copy link
Contributor Author

@di sorry for pinging, but is there any interest in merging this from pypa's side?

Copy link
Sponsor Member

@di di left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@di
Copy link
Sponsor Member

di commented Oct 30, 2023

(Looks like we have some unrelated test failures here that need to be resolved first)

VladimirFokow added a commit to VladimirFokow/sampleproject that referenced this pull request Feb 3, 2024
add the changes authored by thomasbbrunner in pypa#197
@di di merged commit b1dfa48 into pypa:main Feb 29, 2024
15 checks passed
di added a commit that referenced this pull request Feb 29, 2024
* Update pyproject.toml

- extend descriptions of build-system table
- add useful links
- edit other comments

* Update pyproject.toml

- be more clear that the values in [build-system] may be generated by the command line interface of the build backend, so the [build-system] table is not required
- reorganize comments to better correspond to their sections

* add changes from #197

add the changes authored by thomasbbrunner in #197

* implement changes from code review

- separate links to guide and specification
- remove text that can already be found by following the provided links
- more accurate comment about the `build-backend` key

* minor: ":"

* better comment about extras

Co-authored-by: chrysle <[email protected]>

* remove # Optional coments, because instead of them we'll mark the REQUIRED fields

---------

Co-authored-by: chrysle <[email protected]>
Co-authored-by: Dustin Ingram <[email protected]>
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

Successfully merging this pull request may close these issues.

3 participants