docs: specify return type of objDisplay (#1490)

scarf005 · web-flow · commit 3a8c49a70733 · 2022-12-05T11:20:08.000Z
previously it was incorrectly labeled as `objDisplay(obj: object): void` in `@types/chai`.
diff --git a/lib/chai/utils/objDisplay.js b/lib/chai/utils/objDisplay.js
@@ -19,6 +19,7 @@ var config = require('../config');
  * messages or should be truncated.
  *
  * @param {Mixed} javascript object to inspect
+ * @returns {string} stringified object
  * @name objDisplay
  * @namespace Utils
  * @api public

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ var config = require('../config');`
`19`	`19`	`* messages or should be truncated.`
`20`	`20`	`*`
`21`	`21`	`* @param {Mixed} javascript object to inspect`
	`22`	`+ * @returns {string} stringified object`
`22`	`23`	`* @name objDisplay`
`23`	`24`	`* @namespace Utils`
`24`	`25`	`* @api public`