search

gruntjs / gruntjs.com

Grunt website
https://gruntjs.com
Other
155 stars 85 forks source link

`grunt.file` documents unreleased feature: grunt.file.copy options "process" #236

Open JKVeganAbroad opened 8 years ago

JKVeganAbroad commented 8 years ago

Originally report: Issue # 1440 (gruntjs/grunt)

grunt.file.md advises that for the grunt.file.copy function:

  // The source file contents, source file path, and destination file path 
  // are passed into this function, whose return value will be used as the
  // destination file's contents. If this function returns `false`, the file
  // copy will be aborted.
  process: processFunction,

In particular: "The ... destination file path [is] passed into this function"

As of the latest release of Grunt, 0.4.5, this is not true. The documentation needs to be corrected to remove this, or advise that it will be available in future releases.

AurelioDeRosa commented 8 years ago

Hi @JKAussieSkater. Are you working on this issue? If not, I'd like to submit a PR in the next few days. Let me know what you think.

JKVeganAbroad commented 8 years ago

Please go for it! I was hoping to get it done before I went back to university/college, but I couldn't quite squeeze it in!

AurelioDeRosa commented 8 years ago

Do you mind assign it to me as a reminder?

Krinkle commented 3 weeks ago

Per https://github.com/gruntjs/gruntjs.com/issues/233, I suggest we improve it by stating that it was "Added in vX" with the release where it was added.