GH-73991: Split "Directory and file operations" section in shutil docs #119159
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…il docs Split "Directory and file operations" section in five: 1. "Copying files" 2. "Recursively copying, moving and removing" 3. "Querying disk usage" 4. "Changing file ownership" 5. "Finding executables" The "Platform-dependent efficient copy operations" information is moved to "Copying files". The examples of `copytree()` and `rmtree()` are moved into their function docs. This should be slightly easier to navigate for users, and draws more of a distinction between the lower-level file copying functions and the higher-level `copytree()` / `rmtree()` / `move()` functions.
bedevere-app
bot
added
docs
pfmoore
reviewed
May 18, 2024
| return [] # nothing will be ignored | ||
|
|
||
| copytree(source, destination, ignore=_logpath) | ||
|
|
There was a problem hiding this comment.
Taken in isolation, this example seems weird, as it's not actually ignoring anything. I'd suggest keeping the ignore_patterns example from the original text as well, and describe this example as something like:
You don't have to ignore anything, if you simply want to run some code for every directory that gets processed. For example, this snippet uses the ignore argument to add a logging call::
pfmoore
reviewed
May 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split "Directory and file operations" section in five:
The "Platform-dependent efficient copy operations" information is moved to "Copying files". The examples of
copytree()andrmtree()are moved into their function docs.This should be slightly easier to navigate for users, and draws more of a distinction between the lower-level file copying functions and the higher-level
copytree()/rmtree()/move()functions.📚 Documentation preview 📚: https://cpython-previews--119159.org.readthedocs.build/