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.

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

Jump to bottom

Split a pyproject.toml guide out of the "Declaring project metadata" specification #1350

Merged
merged 11 commits into from
Nov 14, 2023
Merged

Split a pyproject.toml guide out of the "Declaring project metadata" specification #1350

merged 11 commits into from
Nov 14, 2023

Conversation

jeanas
Copy link
Contributor

@jeanas jeanas commented Nov 5, 2023

Fixes #1349

@sinoroc
Copy link
Contributor

sinoroc commented Nov 5, 2023

Thanks @jeanas

Shortcut to preview: https://python-packaging-user-guide--1350.org.readthedocs.build/en/1350/guides/writing-pyproject-toml/

@jeanas jeanas mentioned this pull request Nov 5, 2023
Closed
chrysle
chrysle reviewed Nov 9, 2023
View reviewed changes
source/guides/writing-pyproject-toml.rst Outdated Show resolved Hide resolved
source/guides/writing-pyproject-toml.rst Outdated Show resolved Hide resolved
source/guides/writing-pyproject-toml.rst Show resolved Hide resolved
source/guides/writing-pyproject-toml.rst Outdated Show resolved Hide resolved
willingc
willingc reviewed Nov 9, 2023
View reviewed changes
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Overall, I like this PR. I'm concerned about removing content from a specification. Do you think the removal is necessary?

source/specifications/declaring-project-metadata.rst Show resolved Hide resolved
willingc
willingc reviewed Nov 11, 2023
View reviewed changes
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

I like having the new doc which will be helpful. I'm just not sure that it adds value to remove the examples from the spec.

source/specifications/declaring-project-metadata.rst Show resolved Hide resolved
willingc
willingc approved these changes Nov 12, 2023
View reviewed changes
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

@jeanas I'm approving this PR since I like the new doc. I will leave to you and others when to merge re: spec changes. We can always add the removals back as needed at a later date.

Very happy to see the activity the past few weeks to make improvements. ✨

sinoroc
sinoroc reviewed Nov 12, 2023
View reviewed changes
Copy link
Contributor

@sinoroc sinoroc left a comment

Choose a reason for hiding this comment

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

Great!

More links maybe?

source/guides/writing-pyproject-toml.rst Outdated Show resolved Hide resolved
source/guides/writing-pyproject-toml.rst Outdated Show resolved Hide resolved
@willingc
Copy link
Contributor

I've opened #1390 to document guidance on when to change specifications. This PR is better than the current documentation, and I will merge when CI completes. Thanks for the patience @jeanas.

@willingc willingc added this pull request to the merge queue Nov 14, 2023
@jeanas
Copy link
Contributor Author

jeanas commented Nov 14, 2023 •
edited
Loading

Thank you, @willingc.

Merged via the queue into pypa:main with commit a9e56ee Nov 14, 2023
5 checks passed
@jeanas jeanas deleted the pyproject-guide branch November 14, 2023 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sinoroc sinoroc sinoroc left review comments

@chrysle chrysle chrysle left review comments

@willingc willingc willingc approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create a pyproject.toml guide (vs specification)
4 participants
@jeanas @sinoroc @willingc @chrysle