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

fix documents about copy/copySync #205

Closed
chinesedfan opened this issue Dec 28, 2015 · 5 comments
Closed

fix documents about copy/copySync #205

chinesedfan opened this issue Dec 28, 2015 · 5 comments

Comments

@chinesedfan
Copy link
Contributor

I think these 2 methods should share the same options. But:

  1. By default, preserveTimestamps is false in copy as the document describes, while it is true in copySync.
  2. For copy, options transform/dereference/limit/errs/stopOnError are undocumented. Maybe we can refer to ncp in somewhere.
  3. For copySync, options recursive is also undocumented.

By the way, I was addicted to something else and sorry for leaving issue #198 still open. XD.

@jprichardson
Copy link
Owner

Thanks for pointing these out.

  1. That definitely needs to be fixed.
  2. I purposely left some of these out of the documentation as I wasn't sure if I was willing to support them long-term or if I'd change/rename them.
  3. Same here.

Thanks for bringing this issue up though, as it needs to be fixed.

@jprichardson
Copy link
Owner

Reopened as #208 doesn't solve 2. and 3..

@chinesedfan
Copy link
Contributor Author

What's your plan about 2&3?
How about just adding some words mention those options? And warn users they are not stable.

@jprichardson
Copy link
Owner

What's your plan about 2&3?
How about just adding some words mention those options? And warn users they are not stable.

The problem is that if they're documented, despite my warnings, people will use them.

@RyanZim
Copy link
Collaborator

RyanZim commented Oct 26, 2016

The problem is that if they're documented, despite my warnings, people will use them.

Good point. copy is long due an overhaul, and those options may change then. We'll fix the docs then.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

3 participants