-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Add a dedicated "Build system interface" reference section #10497
Conversation
Toward #9475. |
@pypa/pip-committers I'd really like for someone to take a proper look at this PR -- it's a decently large change, and very much worthwhile IMO. However, it is also one of the places where we should get the nuances and phrasing right and to be something that we're comfortable with. Here's the link to the preview: https://pip--10497.org.readthedocs.build/en/10497/ -- you'll wanna look under Reference. :) |
c34a091
to
265f138
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, this looks good. I've added a bunch of comments, but they are mainly just clarifications of things I think are a bit unclear, and one or two nitpicks.
The most substantial query is around the setup_requires
explanation, which I think might have some inaccuracies.
This reworks a substantial portion of our existing build system related documentation, putting it all in a single location. There are certain areas that have been rephrased or rewritten: - The setup.py interface is now considered an implementation detail. - The setup.py interface is explicitly noted as a legacy interface, due for removal. - The pyproject.toml interface now has clearer documentation on how it is used and how it operates. - Clearer separation of `--use-pep-517` and `--no-build-isolation`, to make the difference between the two clearer.
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
265f138
to
25a31d4
Compare
It wasn't clear what "those dependencies" refers to.
@pfmoore That should be all the feedback addressed! I'd like you to take a look at the PS: I added you as a co-author on one of the commits, since a lot of the stuff in it is based on copy-pasting what you've suggested. :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. One spelling nit is all.
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
This reworks a substantial portion of our existing build system related
documentation, putting it all in a single location.
There are certain areas that have been rephrased or rewritten:
for removal.
is used and how it operates.
--use-pep-517
and--no-build-isolation
, tomake the difference between the two clearer.