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

Improve documentation for in-place builds #8093

Merged
merged 1 commit into from
Apr 19, 2020

Conversation

pradyunsg
Copy link
Member

Follow up on #7882 (comment).

@pradyunsg pradyunsg added type: docs Documentation related skip news Does not need a NEWS file entry (eg: trivial changes) labels Apr 19, 2020
@pradyunsg pradyunsg added this to the 20.1 milestone Apr 19, 2020
@pradyunsg pradyunsg force-pushed the better-docs-for-in-place-builds branch from 7eca891 to 756b02f Compare April 19, 2020 20:54
@pradyunsg pradyunsg added the !release blocker Hold a release until this is resolved label Apr 19, 2020
@pradyunsg
Copy link
Member Author

So, uh, I am feeling a little reckless here, this is a documentation-only change, I don't think this is a break-the-bank change as a whole, and we can fix everything except the NEWS fragment later, so...

My point is, I'm merging this without reviews and feeling a little guilty about doing this. :)

@pradyunsg pradyunsg merged commit a531a15 into pypa:master Apr 19, 2020
@pradyunsg pradyunsg deleted the better-docs-for-in-place-builds branch April 19, 2020 21:57
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.
Copy link
Member

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 or build directories get created) in the changelog could have increased uor chances to get better feedback during the beta period.

Copy link
Member Author

@pradyunsg pradyunsg Apr 21, 2020

Choose a reason for hiding this comment

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

You are correct! And...

we can fix everything except the NEWS fragment later

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 on master directly to add this information.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
!release blocker Hold a release until this is resolved skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants