-
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
Improve documentation for in-place builds #8093
Merged
pradyunsg
merged 1 commit into
pypa:master
from
pradyunsg:better-docs-for-in-place-builds
Apr 19, 2020
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,2 @@ | ||
Building of local directories is now done in place. Previously pip did copy the | ||
local directory tree to a temporary location before building. That approach had | ||
a number of drawbacks, among which performance issues, as well as various | ||
issues arising when the python project directory depends on its parent | ||
directory (such as the presence of a VCS directory). The user visible effect of | ||
this change is that secondary build artifacts, if any, may therefore be created | ||
in the local directory, whereas before they were created in a temporary copy of | ||
the directory and then deleted. This notably includes the ``build`` and | ||
``.egg-info`` directories in the case of the setuptools build backend. | ||
Building of local directories is now done in place, instead of a temporary | ||
location containing a copy of the directory tree. | ||
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.
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.
@pradyunsg I think that calling out the effect of this change (namely that
.egg-info
orbuild
directories get created) in the changelog could have increased uor chances to get better feedback during the beta period.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.
You are correct! And...
I just realized that this is not true.
RTD is smart enough to detect beta release numbers, so that they don't end up on
stable
. So... we can update the NEWS.rst file onmaster
directly to add this information.