Skip to content

Commit 0071490

Browse files
committed
[doc] Update JSDoc comment
1 parent a7044e3 commit 0071490

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

index.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ var required = require('requires-port')
99
, windowsDriveLetter = /^[a-zA-Z]:/;
1010

1111
/**
12-
* Trim a given string.
12+
* Remove control characters and whitespace from the beginning of a string.
1313
*
14-
* @param {String} str String to trim.
14+
* @param {Object|String} str String to trim.
15+
* @returns {String} A new string representing `str` stripped of control
16+
* characters and whitespace from its beginning.
1517
* @public
1618
*/
1719
function trimLeft(str) {

0 commit comments

Comments
 (0)