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-40982: Fix outdated copytree() "example" in the shutil docs #24778

Merged
merged 2 commits into from
Apr 5, 2022
Merged

bpo-40982: Fix outdated copytree() "example" in the shutil docs #24778

merged 2 commits into from
Apr 5, 2022

Conversation

ZackerySpytz
Copy link
Contributor

@ZackerySpytz ZackerySpytz commented Mar 7, 2021 •
edited by bedevere-bot
Loading

It is not preferable to keep a copy of the implementation in the
docs.

https://bugs.python.org/issue40982

@ZackerySpytz
bpo-40982: Fix outdated copytree() "example" in the shutil docs
0ae62d7 
It is not preferable to keep a copy of the implementation in the
docs.
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Mar 7, 2021
@github-actions
Copy link

github-actions bot commented Apr 7, 2021

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Apr 7, 2021
nanjekyejoannah
nanjekyejoannah reviewed May 29, 2021
View reviewed changes
Doc/library/shutil.rst
@@ -470,42 +470,7 @@ file then shutil will silently fallback on using less efficient
copytree example
~~~~~~~~~~~~~~~~
Copy link
Contributor

Choose a reason for hiding this comment

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

I think removing it would make sense but you leave a hanging heading. Do you have a reason for this?

Also, the bpo asked for a fix to the example, I would think deciding to remove it instead requires some consensus, maybe @willingc and @Mariatta can advise.

Copy link
Member

Choose a reason for hiding this comment

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

I don't think this leaves the header dangling - it relates to the next example (not that the last modified like changes "Another example..." to "An example...", because the next one is now the first).

@JelleZijlstra JelleZijlstra added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Apr 3, 2022
@JelleZijlstra JelleZijlstra self-assigned this Apr 3, 2022
@JelleZijlstra JelleZijlstra merged commit e06f920 into python:main Apr 5, 2022
@miss-islington
Copy link
Contributor

Thanks @ZackerySpytz for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 5, 2022
@ZackerySpytz @miss-islington
bpo-40982: shutil docs: Remove outdated copytree() example (pythonGH-…
0473b2a 
…24778)

It is not preferable to keep a copy of the implementation in the
docs.
(cherry picked from commit e06f920)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 5, 2022
@ZackerySpytz @miss-islington
bpo-40982: shutil docs: Remove outdated copytree() example (pythonGH-…
39a72d6 
…24778)

It is not preferable to keep a copy of the implementation in the
docs.
(cherry picked from commit e06f920)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
@bedevere-bot
Copy link

GH-32326 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Apr 5, 2022
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Apr 5, 2022
miss-islington added a commit that referenced this pull request Apr 5, 2022
@miss-islington @ZackerySpytz
bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778)
857cf55 
It is not preferable to keep a copy of the implementation in the
docs.
(cherry picked from commit e06f920)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
miss-islington added a commit that referenced this pull request Apr 5, 2022
@miss-islington @ZackerySpytz
bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778)
bc9ec24 
It is not preferable to keep a copy of the implementation in the
docs.
(cherry picked from commit e06f920)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@miss-islington @ZackerySpytz @hello-adam
bpo-40982: shutil docs: Remove outdated copytree() example (pythonGH-…
05cc3e6 
…24778)

It is not preferable to keep a copy of the implementation in the
docs.
(cherry picked from commit e06f920)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iritkatriel iritkatriel iritkatriel left review comments

@nanjekyejoannah nanjekyejoannah nanjekyejoannah left review comments

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

Assignees

@JelleZijlstra JelleZijlstra

Labels
docs Documentation in the Doc dir skip news stale Stale PR or inactive for long period of time.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ZackerySpytz @miss-islington @bedevere-bot @JelleZijlstra @iritkatriel @nanjekyejoannah @the-knights-who-say-ni