Comment formatting review fixes

Author: Eric Millin

lib/test.js

@@ -107,10 +107,13 @@ Test.prototype.test = function (name, opts, cb) {
     });
 };
 
-Test.prototype.comment = function () {
+Test.prototype.comment = function (msg) {
     var that = this;
-    var keys = Object.keys(arguments)
-    var msg = keys.length > 1 ? format.apply(null, arguments) : arguments[keys[0]];
+
+    // Previous behavior involved `toString` calls on objects, i.e. emitting `[object Object]`.
+    // `util.format`, however, will print stringified objects. To maintain backward compatibility
+    // check the args length and only call `util.format` if the invoker desires string expansion.
+    msg = arguments.length > 1 ? format.apply(null, arguments) : msg;
 
     trim(msg).split('\n').forEach(function (aMsg) {
         that.emit('result', trim(aMsg).replace(/^#\s*/, ''));

readme.markdown

@@ -273,8 +273,7 @@ You may pass the same options that [`test()`](#testname-opts-cb) accepts.
 
 ## t.comment(message[, ...])
 
-Print a message without breaking the tap output. Accepts optional args for `util.format`-style formatting.
-(Useful when using e.g. `tap-colorize` where output is buffered & `console.log` will print in incorrect order vis-a-vis tap output.)
+Print a message without breaking the tap output. Accepts optional args for `util.format`-style formatting. Useful when using e.g. `tap-colorize` where output is buffered & `console.log` will print in incorrect order vis-a-vis tap output.
 
 ## var htest = test.createHarness()
 

test/comment.js

@@ -226,4 +226,4 @@ tap.test('formatted multiline string', function (assert) {
         t.comment("tip\n%s\nt%s", "tap", "ape");
         t.end();
     });
-});
+});