bpo-22021: Update root_dir and base_dir documentation in shutil #10367

lysnikolaou · 2018-11-06T18:08:12Z

Also added an example in shutil in order to make more clear how they are to be used.

Initially reported by Weinan Li on bpo.

https://bugs.python.org/issue22021

Automerge-Triggered-By: @gvanrossum

…ample in shutil in order to make more clear how they are to be used

Doc/library/shutil.rst

remilapeyre · 2019-03-04T10:50:41Z

Doc/library/shutil.rst

 archive; for example, we typically chdir into *root_dir* before creating the
- archive.
+ archive. This also means that all paths in the archive will be relative to
+ *root_dir*.


What do you think of

*root_dir* is a directory that will be the root directory of the archive, all paths in the archive will be relative to it; for example, we typically chdir into *root_dir* before creating the archive.

?

I like it better. I can remember having some difficulties in the wording of this. Thanks for your suggestion.

Doc/library/shutil.rst

remilapeyre · 2019-03-04T12:54:17Z

Thanks for taking the time to improve the documentation, can you have a look as to why the CI is failing?

https://travis-ci.org/python/cpython/jobs/501463292

…es in the added example

lysnikolaou · 2019-03-04T13:23:14Z

@remilapeyre It turns out it was only a trailing whitespace, which is now fixed.

Doc/library/shutil.rst

berkerpeksag · 2019-05-13T19:31:11Z

Doc/library/shutil.rst

 -rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts


+.. _shutil-archiving-example-with-basedir:


Could you please link to the example from the make_archive() documentation?

Thanks @berkerpeksag for the review. From where exactly would you think it would be best to link? From the title itself or from somewhere in the text?

I'm thinking about adding something like "See :ref:`shutil-archiving-example-with-basedir` for how to use *base_dir* and *root_dir* together." after https://github.com/python/cpython/pull/10367/files#diff-bda6196613f849e0aa43c7e2dd9f6068R540

What do you think?

That would be really nice actually. This way someone, who might not scroll all the way down, will not miss the example. I think it may be a better idea to not have a whole new paragraph for the "See the example" bit. It feels more natural to me to just append it at the end of the current paragraph. What is your view on that?

Sounds good to me!

bedevere-bot · 2019-05-13T19:31:22Z

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.

…the example code, tree output for the directory structure

lysnikolaou · 2019-05-13T22:02:20Z

@berkerpeksag, thanks for the review. I have made the requested changes; please review again. I have included a link to the make_archive example in the text, but I'm not really sure that's what you had in mind.

bedevere-bot · 2019-05-13T22:02:23Z

Thanks for making the requested changes!

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

Doc/library/shutil.rst

lysnikolaou · 2019-05-14T11:36:58Z

@berkerpeksag I have pushed the necessary changes, so the PR might be ready for another (final?) review.

miss-islington · 2020-06-08T05:01:22Z

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

miss-islington · 2020-06-08T05:01:22Z

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

miss-islington · 2020-06-08T05:01:22Z

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

miss-islington · 2020-06-08T05:01:22Z

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

miss-islington · 2020-06-08T05:01:24Z

Thanks @lysnikolaou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7, 3.8, 3.9.
🐍🍒⛏🤖

…onGH-10367) Also added an example in shutil in order to make more clear how they are to be used. Initially reported by Weinan Li on bpo. (cherry picked from commit 7633371) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>

bedevere-bot · 2020-06-08T05:01:39Z

GH-20709 is a backport of this pull request to the 3.9 branch.

bedevere-bot · 2020-06-08T05:01:47Z

GH-20710 is a backport of this pull request to the 3.8 branch.

…onGH-10367) Also added an example in shutil in order to make more clear how they are to be used. Initially reported by Weinan Li on bpo. (cherry picked from commit 7633371) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>

bedevere-bot · 2020-06-08T05:01:55Z

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

bedevere-bot · 2020-06-08T05:02:02Z

GH-20712 is a backport of this pull request to the 3.6 branch.

…onGH-10367) Also added an example in shutil in order to make more clear how they are to be used. Initially reported by Weinan Li on bpo. (cherry picked from commit 7633371) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>

…0367) Also added an example in shutil in order to make more clear how they are to be used. Initially reported by Weinan Li on bpo. (cherry picked from commit 7633371) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>

bpo-22021: Update root_dir and base_dir documentation and added an ex…

1a377d8

…ample in shutil in order to make more clear how they are to be used

the-knights-who-say-ni added the CLA signed label Nov 6, 2018

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Nov 6, 2018

remilapeyre reviewed Mar 4, 2019

View reviewed changes

Doc/library/shutil.rst Outdated Show resolved Hide resolved

remilapeyre reviewed Mar 4, 2019

View reviewed changes

Doc/library/shutil.rst Outdated Show resolved Hide resolved

remilapeyre approved these changes Mar 4, 2019

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Mar 4, 2019

bpo-22021: Better wording in the explanation of root dir, minor chang…

6adce16

…es in the added example

lysnikolaou force-pushed the bpo22021 branch from 6119cd3 to 6adce16 Compare March 4, 2019 13:04

csabella assigned giampaolo Apr 15, 2019

csabella requested a review from giampaolo April 15, 2019 14:30

csabella unassigned giampaolo Apr 15, 2019

berkerpeksag requested changes May 13, 2019

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting core review labels May 13, 2019

berkerpeksag added the skip news label May 13, 2019

bpo-22021: Yet another rewording of the explanation, minor tweaks to …

2d3f205

…the example code, tree output for the directory structure

bedevere-bot added awaiting change review and removed awaiting changes labels May 13, 2019

berkerpeksag reviewed May 13, 2019

View reviewed changes

Doc/library/shutil.rst Outdated Show resolved Hide resolved

bpo-22021: Link to the example from the make_archive function docs

55858e7

gvanrossum added needs backport to 3.7 labels Jun 8, 2020

miss-islington merged commit 7633371 into python:master Jun 8, 2020

bedevere-bot removed the awaiting merge label Jun 8, 2020

bedevere-bot removed the needs backport to 3.9 label Jun 8, 2020

bedevere-bot removed the needs backport to 3.8 label Jun 8, 2020

bedevere-bot removed the needs backport to 3.7 label Jun 8, 2020

bedevere-bot removed the needs backport to 3.6 label Jun 8, 2020

hauntsaninja mentioned this pull request Oct 29, 2022

shutil.make_archive() root_dir do not work #66220

Closed

		-rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts


		.. _shutil-archiving-example-with-basedir:

Uh oh!

bpo-22021: Update root_dir and base_dir documentation in shutil #10367

bpo-22021: Update root_dir and base_dir documentation in shutil #10367

Uh oh!

Conversation

lysnikolaou commented Nov 6, 2018 • edited by miss-islington Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

remilapeyre Mar 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

lysnikolaou Mar 4, 2019

Choose a reason for hiding this comment

Uh oh!

remilapeyre commented Mar 4, 2019

lysnikolaou commented Mar 4, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

berkerpeksag May 13, 2019

Choose a reason for hiding this comment

lysnikolaou May 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

berkerpeksag May 13, 2019

Choose a reason for hiding this comment

lysnikolaou May 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

berkerpeksag May 13, 2019

Choose a reason for hiding this comment

bedevere-bot commented May 13, 2019

lysnikolaou commented May 13, 2019

bedevere-bot commented May 13, 2019

Uh oh!

lysnikolaou commented May 14, 2019

miss-islington commented Jun 8, 2020

miss-islington commented Jun 8, 2020

miss-islington commented Jun 8, 2020

miss-islington commented Jun 8, 2020

miss-islington commented Jun 8, 2020

bedevere-bot commented Jun 8, 2020

bedevere-bot commented Jun 8, 2020

bedevere-bot commented Jun 8, 2020

bedevere-bot commented Jun 8, 2020

Labels

8 participants

lysnikolaou commented Nov 6, 2018 •

edited by miss-islington

Loading

remilapeyre Mar 4, 2019 •

edited

Loading

lysnikolaou May 13, 2019 •

edited

Loading

lysnikolaou May 13, 2019 •

edited

Loading