api returns: copy returns copied target file#259
Merged
Conversation
Step 3b for #197 (comment) Docstring was slightly incorrect. We don't always return `target-path`, we return the copied target file. For example, `(fs/copy "file" "dir")` returns `dir/file`, not `dir`. For consistency, moved "Returns..." in docstring above Options. Renamed `source-file` arg to `source`; it can also be an input stream. (This was announced in changelog but never documented) When `source` was input-stream we were returning the number of bytes copied, corrected to return the copied target file. Tests for `copy` adjusted accordingly.
Contributor
|
Thank you! |
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
2 participants
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.
Step 3b for #197 (comment)
Docstring was slightly incorrect. We don't always return
target-path, we return the copied target file. For example,(fs/copy "file" "dir")returnsdir/file, notdir.For consistency, moved "Returns..." in docstring above Options.
Renamed
source-filearg tosource; it can also be an input stream. (This was announced in changelog but never documented)When
sourcewas input-stream we were returning the number of bytes copied, corrected to return the copied target file.Tests for
copyadjusted accordingly.Please answer the following questions and leave the below in as part of your PR.
This PR corresponds to an issue with a clear problem statement.
This PR contains a test to prevent against future regressions
I have updated the CHANGELOG.md file with a description of the addressed issue.