Skip to content

bpo-25592: improve documentation of data_files - #9767

Merged
pitrou merged 1 commit into
python:masterfrom
jdemeyer:bpo25592
Jan 30, 2019
Merged

bpo-25592: improve documentation of data_files#9767
pitrou merged 1 commit into
python:masterfrom
jdemeyer:bpo25592

Conversation

@jdemeyer

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

Copy link
Copy Markdown
Contributor
  • 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

jdemeyer commented Jan 25, 2019

Copy link
Copy Markdown
Contributor Author

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

pitrou
pitrou requested changes Jan 29, 2019
View reviewed changes
Comment thread Doc/distutils/setupscript.rst Outdated

@pitrou pitrou Jan 29, 2019

Copy link
Copy Markdown
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?).

@jdemeyer jdemeyer Jan 30, 2019

Copy link
Copy Markdown
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.

Comment thread Doc/distutils/setupscript.rst Outdated

@pitrou pitrou Jan 29, 2019

Copy link
Copy Markdown
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?

@jdemeyer jdemeyer Jan 30, 2019

Copy link
Copy Markdown
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

bedevere-bot commented Jan 29, 2019

Copy link
Copy Markdown

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

jdemeyer commented Jan 30, 2019

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.

@bedevere-bot

bedevere-bot commented Jan 30, 2019

Copy link
Copy Markdown

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

miss-islington commented Jan 30, 2019

Copy link
Copy Markdown
Contributor

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

@pitrou

pitrou commented Jan 30, 2019

Copy link
Copy Markdown
Member

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

bedevere-bot commented Jan 30, 2019

Copy link
Copy Markdown

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

jdemeyer commented Feb 2, 2019

Copy link
Copy Markdown
Contributor Author

Please backport also to 2.7

@miss-islington

miss-islington commented Feb 2, 2019

Copy link
Copy Markdown
Contributor

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

@bedevere-bot

bedevere-bot commented Feb 2, 2019

Copy link
Copy Markdown

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
+1 more reviewer
@eamanu eamanu eamanu approved these changes
Reviewers whose approvals may not affect merge requirements

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