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

bpo-25592: improve documentation of data_files #9767

Merged
merged 1 commit into from
Jan 30, 2019
Merged

bpo-25592: improve documentation of data_files #9767

merged 1 commit into from
Jan 30, 2019

Conversation

jdemeyer
Copy link
Contributor

@jdemeyer jdemeyer commented Oct 9, 2018 •
edited by bedevere-bot
Loading

  • Remove the part saying that data_files can be installed in exec_prefix (this is simply not true).
  • Mention that data_files are installed in site.USER_BASE for user installations.
  • Discourage absolute filenames since wheel does not support those.
  • Reorganized the text a bit.

https://bugs.python.org/issue25592

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Oct 9, 2018
@jdemeyer
Copy link
Contributor Author

CC @dstufft (as suggested by https://devguide.python.org/experts/)

pitrou
pitrou requested changes Jan 29, 2019
View reviewed changes
Doc/distutils/setupscript.rst Outdated
:file:`setup.py` script at the top of the package source distribution. No
directory information from *files* is used to determine the final location of
The *directory* should be a relative path.
It is interpreted relative to the installation prefix
Copy link
Member

Choose a reason for hiding this comment

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

Side note: would be nice if the reST source stayed formatted evenly (i.e. 78 chars per line, roughly?).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you prefer... I don't think that's a good convention (it makes diffs messier) but I'll do it just for the sake of it.

Doc/distutils/setupscript.rst Outdated
(Python's ``sys.prefix`` for system installations; ``site.USER_BASE`` for user installations).
Each file name in *files* is interpreted relative to the
:file:`setup.py` script at the top of the package source distribution.
Distutils allows *directory* to be an absolute installation path,
Copy link
Member

Choose a reason for hiding this comment

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

Move the sentence in the directory description above? i.e, have two paragraphs: one describing directory, the other describing files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't quite follow what you were saying here, but I did organize the text in two paragraphs: the first about files, the second about directory.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@jdemeyer
Copy link
Contributor Author

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@pitrou: please review the changes made to this pull request.

@pitrou pitrou merged commit 598e15d into python:master Jan 30, 2019
@miss-islington
Copy link
Contributor

Thanks @jdemeyer for the PR, and @pitrou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

@pitrou
Copy link
Member

pitrou commented Jan 30, 2019

Thanks @jdemeyer !

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 30, 2019
@jdemeyer @miss-islington
bpo-25592: Improve documentation of distutils data_files (pythonGH-9767)
9569b1b 
(cherry picked from commit 598e15d)

Co-authored-by: jdemeyer <J.Demeyer@UGent.be>
@bedevere-bot
Copy link

GH-11701 is a backport of this pull request to the 3.7 branch.

pitrou pushed a commit that referenced this pull request Jan 30, 2019
@miss-islington @jdemeyer @pitrou
bpo-25592: Improve documentation of distutils data_files (GH-9767) (G…
ebae1ce 
…H-11701)

(cherry picked from commit 598e15d)

Co-authored-by: jdemeyer <J.Demeyer@UGent.be>
@jdemeyer
Copy link
Contributor Author

jdemeyer commented Feb 2, 2019

Please backport also to 2.7

@miss-islington
Copy link
Contributor

Thanks @jdemeyer for the PR, and @pitrou for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-11734 is a backport of this pull request to the 2.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 2, 2019
@jdemeyer @miss-islington
bpo-25592: Improve documentation of distutils data_files (pythonGH-9767)
1c8a646 
(cherry picked from commit 598e15d)

Co-authored-by: jdemeyer <J.Demeyer@UGent.be>
pitrou pushed a commit that referenced this pull request Feb 2, 2019
@miss-islington @jdemeyer @pitrou
bpo-25592: Improve documentation of distutils data_files (GH-9767) (G…
40a101d 
…H-11734)

(cherry picked from commit 598e15d)

Co-authored-by: jdemeyer <J.Demeyer@UGent.be>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pitrou pitrou pitrou approved these changes

@eamanu eamanu eamanu approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jdemeyer @bedevere-bot @miss-islington @pitrou @eamanu @the-knights-who-say-ni