diff options
author | Roman Reiss <me@silverwind.io> | 2016-11-11 23:29:01 +0300 |
---|---|---|
committer | Roman Reiss <me@silverwind.io> | 2016-11-13 10:58:13 +0300 |
commit | 8eb19c48fa8f69e284a04a02cfd16f06c67f51e0 (patch) | |
tree | 8d4b7df977f51d64b50400864760765797f58c47 /doc/api/path.md | |
parent | 4b35f25bfaa19477237c0e19115e12b22dc7c6ff (diff) |
doc: consistent 'Returns:'
For consistency, changed all `Return:` to `Returns:` in the API docs.
PR-URL: https://github.com/nodejs/node/pull/9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Diffstat (limited to 'doc/api/path.md')
-rw-r--r-- | doc/api/path.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/api/path.md b/doc/api/path.md index 6a65f17be5b..45dac1069ce 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -61,7 +61,7 @@ added: v0.1.25 * `path` {String} * `ext` {String} An optional file extension -* Return: {String} +* Returns: {String} The `path.basename()` methods returns the last portion of a `path`, similar to the Unix `basename` command. @@ -117,7 +117,7 @@ added: v0.1.16 --> * `path` {String} -* Return: {String} +* Returns: {String} The `path.dirname()` method returns the directory name of a `path`, similar to the Unix `dirname` command. @@ -137,7 +137,7 @@ added: v0.1.25 --> * `path` {String} -* Return: {String} +* Returns: {String} The `path.extname()` method returns the extension of the `path`, from the last occurrence of the `.` (period) character to end of string in the last portion of @@ -177,7 +177,7 @@ added: v0.11.15 * `base` {String} * `name` {String} * `ext` {String} -* Return: {String} +* Returns: {String} The `path.format()` method returns a path string from an object. This is the opposite of [`path.parse()`][]. @@ -250,7 +250,7 @@ added: v0.11.2 --> * `path` {String} -* Return: {Boolean} +* Returns: {Boolean} The `path.isAbsolute()` method determines if `path` is an absolute path. @@ -285,7 +285,7 @@ added: v0.1.16 --> * `...paths` {String} A sequence of path segments -* Return: {String} +* Returns: {String} The `path.join()` method joins all given `path` segments together using the platform specific separator as a delimiter, then normalizes the resulting path. @@ -312,7 +312,7 @@ added: v0.1.23 --> * `path` {String} -* Return: {String} +* Returns: {String} The `path.normalize()` method normalizes the given `path`, resolving `'..'` and `'.'` segments. @@ -346,7 +346,7 @@ added: v0.11.15 --> * `path` {String} -* Return: {Object} +* Returns: {Object} The `path.parse()` method returns an object whose properties represent significant elements of the `path`. @@ -426,7 +426,7 @@ added: v0.5.0 * `from` {String} * `to` {String} -* Return: {String} +* Returns: {String} The `path.relative()` method returns the relative path from `from` to `to`. If `from` and `to` each resolve to the same path (after calling `path.resolve()` @@ -457,7 +457,7 @@ added: v0.3.4 --> * `...paths` {String} A sequence of paths or path segments -* Return: {String} +* Returns: {String} The `path.resolve()` method resolves a sequence of paths or path segments into an absolute path. |