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.
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.