{{ message }}
GH-73991: Split "Directory and file operations" section in shutil docs#119159
Closed
barneygale wants to merge 1 commit into
Closed
GH-73991: Split "Directory and file operations" section in shutil docs#119159barneygale wants to merge 1 commit into
barneygale wants to merge 1 commit into
Conversation
…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.
pfmoore
reviewed
May 18, 2024
pfmoore
reviewed
May 18, 2024
pfmoore
left a comment
Member
There was a problem hiding this comment.
Apart from the one comment I made (I accidentally clicked "add a single comment" rather than "Start a review" 🙁) this LGTM
Sorry, something went wrong.
Contributor
Author
|
Withdrawing this PR. With the work on GH-73991 at its end, we actually didn't need to touch |
Sorry, something went wrong.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.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.
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/