[doc] Update JSDoc comment

unshiftio · Feb 20, 2022 · 0071490 · 0071490
1 parent a7044e3
commit 0071490
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/index.js b/index.js
@@ -9,9 +9,11 @@ var required = require('requires-port')
   , windowsDriveLetter = /^[a-zA-Z]:/;
 
 /**
- * Trim a given string.
+ * Remove control characters and whitespace from the beginning of a string.
  *
- * @param {String} str String to trim.
+ * @param {Object|String} str String to trim.
+ * @returns {String} A new string representing `str` stripped of control
+ *     characters and whitespace from its beginning.
  * @public
  */
 function trimLeft(str) {