Update append_dir_all doc test #364
Merged
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
## Call `finish`
The text of `append_dir_all` suggests that `finish` must always be called. This commit updates the example to call `finish`.
## Link to `into_inner`
Further, the docs for `finish` suggest that `into_inner` is an alternate (and possibly preferred), so I added a link to that function.
> /// In most situations the `into_inner` method should be preferred.
> pub fn finish(&mut self) -> io::Result<()> {
## Label which directory is which in the comment
Lastly, I needed clarification about which directory was renamed in the example. Without prior knowledge, it could be that a directory named "bardir" is being renamed to the current dir or that the current dir is being inserted as a "bardir." The input args are `path` and `src_path`, which provides a little clue.
To make the example more explicit, I added that information to the comment.
alexcrichton
approved these changes
Aug 22, 2024
|
Thanks for this! |
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.
Call
finishThe text of
append_dir_allsuggests thatfinishmust always be called. This commit updates the example to callfinish.Link to
into_innerFurther, the docs for
finishsuggest thatinto_inneris an alternate (and possibly preferred), so I added a link to that function.Label which directory is which in the comment
Lastly, I needed clarification about which directory was renamed in the example. Without prior knowledge, it could be that a directory named "bardir" is being renamed to the current dir or that the current dir is being inserted as a "bardir." The input args are
pathandsrc_path, which provides a little clue.To make the example more explicit, I added that information to the comment.