Skip to content

Commit 5cc7e86

Browse files
committed
docs: align regexp/extended-length-path with namespace conventions
- Added missing `@example` block to `lib/main.js` JSDoc (present in 26/27 siblings, 96%), adapted from the README usage examples. https://claude.ai/code/session_0151TCuqxNJXJZfy4XEWqKhM
1 parent 78898df commit 5cc7e86

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/regexp/extended-length-path/lib

lib/node_modules/@stdlib/regexp/extended-length-path/lib/main.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@
2424
* Returns a regular expression that matches an extended-length path.
2525
*
2626
* @returns {RegExp} regular expression
27+
*
28+
* @example
29+
* var RE_EXTENDED_LENGTH_PATH = reExtendedLengthPath();
30+
* var bool = RE_EXTENDED_LENGTH_PATH.test( '\\\\?\\C:\\foo\\bar' );
31+
* // returns true
32+
*
33+
* bool = RE_EXTENDED_LENGTH_PATH.test( 'C:\\foo\\bar' );
34+
* // returns false
2735
*/
2836
function reExtendedLengthPath() {
2937
return /^\\\\\?\\.+/;

0 commit comments

Comments
 (0)