Link to build_meta documentation #2415
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
webknjaz
reviewed
Oct 12, 2020
docs/userguide/index.rst
Outdated
| ==================== | ||
|
|
||
| Since setuptools no longer serves as the default build tool, one must explicitly | ||
| opt in (by providing a ``pyproject.toml`` file) to use this library. The user |
There was a problem hiding this comment.
Let's use a :file: role here:
Suggested change
| opt in (by providing a ``pyproject.toml`` file) to use this library. The user | |
| opt in (by providing a :file:`pyproject.toml` file) to use this library. The user |
webknjaz
reviewed
Oct 12, 2020
docs/userguide/index.rst
Outdated
|
|
||
| Since setuptools no longer serves as the default build tool, one must explicitly | ||
| opt in (by providing a ``pyproject.toml`` file) to use this library. The user | ||
| facing part is provided by `PEP517 <https://pypi.org/project/pep517/>`_ and |
There was a problem hiding this comment.
I'm pretty sure that this shouldn't point users to a specific implementation. There's plenty, including pip. I'd rather point to the PEP page using
:pep:`517`Besides, the CLI present in the pep517 package has always been unstable and experimental, and it is being deprecated in favor of another project called build that is about to be accepted under the roof of PyPA: https://mail.python.org/archives/list/pypa-committers@python.org/thread/LNOO7Q2RW55BVYCJK2LP4DEIMHC5D44F/.
|
Thanks for the review. I have made the edits. |
webknjaz
reviewed
Oct 17, 2020
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
I added a paragraph of text in the index that briefly mentions how setuptools works under pep517, and provided a link to the build_meta document as mentioned in (#1698 ).
At first I thought the quickstart has already covered this document, but judging from the discussion, it seems like it still deserves its own page. It appears that the quickstart should target the end users that are not concerned about this internal module.
Pull Request Checklist