Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Clarify move*() docs #888

Merged
merged 2 commits into from
Apr 17, 2021
Merged

Clarify move*() docs #888

merged 2 commits into from
Apr 17, 2021

Conversation

RyanZim
Copy link
Collaborator

@RyanZim RyanZim commented Apr 15, 2021

Fixes #830

Copy link
Collaborator

@manidlou manidlou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RyanZim this is ok but I think it's still not clear that we are not supporting moving a file to a directory. That's something I've seen a lot from users' comments. People think whatever they can do with mv command, they also can do with fs-extra.move(), but we know that's not true! We need to make that clear for our users.

@RyanZim
Copy link
Collaborator Author

RyanZim commented Apr 16, 2021

Yeah, I couldn't figure out a way to state this more clearly; I'm not good with words that way. Any suggestions?

@manidlou
Copy link
Collaborator

To be honest, I am not sure neither but I was thinking something like

dest <String> when src is a file, dest must be a file and when src is a directory, dest must be a directory

@RyanZim RyanZim requested a review from manidlou April 17, 2021 18:24
Copy link
Collaborator

@manidlou manidlou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @RyanZim!

@RyanZim RyanZim merged commit ce29957 into master Apr 17, 2021
@RyanZim RyanZim deleted the ryan/move-docs branch April 17, 2021 19:48
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs to explain whether move supports directories as destination
2 participants