Skip to content

Commit

Permalink
Reworded path strings in Notes
Browse files Browse the repository at this point in the history
  • Loading branch information
thefourtheye committed Jul 6, 2015
1 parent 63874da commit 10b2405
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions doc/api/path.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Example:
// returns
'/foo/bar/baz/asdf'

*Note:* If the path is a zero-length string then the current working directory
will be returned.
*Note:* If the path string passed as argument is a zero-length string then the
current working directory will be returned.

## path.join([path1][, path2][, ...])

Expand All @@ -42,8 +42,8 @@ Example:
// throws exception
TypeError: Arguments to path.join must be strings

*Note:* If the joined path is a zero-length string then the current working
directory will be returned.
*Note:* If the joined path string is a zero-length string then the current
working directory will be returned.

## path.resolve([from ...], to)

Expand Down Expand Up @@ -84,8 +84,8 @@ Examples:
// if currently in /home/myself/iojs, it returns
'/home/myself/iojs/wwwroot/static_files/gif/image.gif'

*Note:* If the path is a zero-length string then the current working directory
will be used.
*Note:* If the arguments to `resolve` are zero-length strings then the current
working directory will be used instead of them.

## path.isAbsolute(path)

Expand All @@ -106,7 +106,9 @@ Windows examples:
path.isAbsolute('bar\\baz') // false
path.isAbsolute('.') // false

*Note:* If the path is a zero-length string then `false` will be returned.
*Note:* If the path string passed as parameter is a zero-length string,
unlike other path module functions, zero-length string will be used
as-is and `false` will be returned.

## path.relative(from, to)

Expand All @@ -128,9 +130,9 @@ Examples:
// returns
'../../impl/bbb'

*Note:* If any of the paths passed are zero-length strings then the current
working directory will be used instead. If both the paths are the same
then a zero-length string will be returned.
*Note:* If the arguments to `relative` are zero-length strings then the current
working directory will be used instead of them. If both the paths are
the same then a zero-length string will be returned.

## path.dirname(p)

Expand Down

0 comments on commit 10b2405

Please sign in to comment.