doc: Inspect method of buffers is missing description

[a0viedo]

buffer.inspect() is referenced at Buffer#INSPECT_MAX_BYTES but no description is found on the same document. Is this intended? It's an internal method only?

[mscdex]

The answer is in the documentation for util.inspect(). Basically any object can implement an inspect() method that will get used by util.inspect() when inspecting that object, so that you can format your object value however you want.

It's kind of like how you can add a .toJSON() method to an object and the value returned by it will be used by JSON.stringify() instead of the default formatting/toString().

[cjihrig]

Maybe that reference to buffer.inspect() should link to util.inspect().

[Fishrock123]

^

[mscdex]

I agree the documentation could be better here, but linking buffer.inspect() itself to somewhere outside of the Buffer documentation page might be a little confusing?

[cjihrig]

Then at least a note saying see util.inspect() for more information. Something to get people there.

[mscdex]

Something like that is fine by me.

[cjihrig]

PR - #3921

[a0viedo]

@cjihrig @mscdex awesome! thanks