Add append_dir_all doc test without renaming #365
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
This adds a doc test that shows how to add the contents of a directory to an archive without renaming them.
## Context
It might seem silly, but I was unsure of the correct way to write all contents of a directory to an archive without renaming. I initially looked for a different associated function that only took one argument but couldn't find one. When that failed I guessed and checked that `"."` would work, and it did. On searching, others used `""`.
It makes sense in hind-site, but I would have loved to have a signal that this was the correct way to perform that operation.
In addition to demonstrating `append_dir_all("", ...` this example also shows usage of `into_inner` to retrieve a reference to the original struct. Which is the recommended alternative to `finish`.
I certainly understand that you can't have an example for every permutation and combination, but I believe that archiving the contents of a directory without renaming is common-enough to warrant an explicit example.
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.
This adds a doc test that shows how to add the contents of a directory to an archive without renaming them.
Context
It might seem silly, but I was unsure of the correct way to write all the contents of a directory to an archive without renaming. I initially looked for a different associated function that only took one argument but couldn't find one. When that failed, I guessed and checked that
"."would work, and it did. On searching, others used"".It makes sense in hind-site, but I would have loved to have a signal that this was the correct way to perform that operation.
In addition to demonstrating
append_dir_all("", ...this example also shows usage ofinto_innerto retrieve a reference to the original struct. Which is the recommended alternative tofinish.I certainly understand that you can't have an example for every permutation and combination, but I believe that archiving the contents of a directory without renaming is common-enough to warrant an explicit example.