doc: fix format docs discrepancy
authorBrendan Ashworth <brendan.ashworth@me.com>
Wed, 25 Mar 2015 05:44:08 +0000 (22:44 -0700)
committerBrendan Ashworth <brendan.ashworth@me.com>
Wed, 25 Mar 2015 15:47:41 +0000 (08:47 -0700)
Only objects and symbols use `util.inspect`, others are simply
concatenated.

Fixes: https://github.com/iojs/io.js/issues/935
PR-URL: https://github.com/iojs/io.js/pull/1255
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
doc/api/util.markdown

index d7abecc..2bc6969 100644 (file)
@@ -63,8 +63,8 @@ not replaced.
     util.format('%s:%s', 'foo'); // 'foo:%s'
 
 If there are more arguments than placeholders, the extra arguments are
-converted to strings with `util.inspect()` and these strings are concatenated,
-delimited by a space.
+coerced to strings (for objects and symbols, `util.inspect()` is used)
+and then concatenated, delimited by a space.
 
     util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'