Bad example code in grunt.log docs?

[russelldavis]

The docs for grunt.log have this example at the bottom of the page:

grunt.registerTask('something', 'Do something interesting.', function(arg) {
  var msg = 'Doing something...';
  grunt.verbose.write(msg);
  try {
    doSomethingThatThrowsAnExceptionOnError(arg);
    // Success!
    grunt.verbose.ok();
  } catch(e) {
    // Something went wrong.
    grunt.verbose.or.write(msg).error().error(e.message);
    grunt.fail.warn('Something went wrong.');
  }
});

The line grunt.verbose.or.write(msg).error().error(e.message); seems wrong to me. Wouldn't you want the calls to error to be logged regardless of the verbose setting? As is, the errors will not be logged in verbose mode, which doesn't seem right. Or am I misunderstanding something?

[shama]

I think it's just an example showing how the API could be used rather than a likely situation. Although I'm always surprised with user preference of logging. Someone having a function named doSomethingThatThrowsAnExceptionOnError() is unlikely too. :)

We're always happy to take pull requests improving the docs if you have a better example that showcases the API though. Thanks!