add docs around stack messaging, close #49

gulpjs · Jun 12, 2014 · fb977f8 · fb977f8
1 parent 626dac3
commit fb977f8
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -108,6 +108,7 @@ gulp.src('stuff/*.js')
 - message can be a string or an existing error
 - By default the stack will not be shown. Set `options.showStack` to true if you think the stack is important for your error.
 - If you pass an error in as the message the stack will be pulled from that, otherwise one will be created.
+- Note that if you pass in a custom stack string you need to include the message along with that.
 
 These are all acceptable forms of instantiation: