Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: path functions ignore trailing slashes #12181

Closed
wants to merge 4 commits into from
Closed

doc: path functions ignore trailing slashes #12181

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
96f2a34
doc: path functions ignore trailing slashes
tniessen Apr 3, 2017
abb4b82
Remove POSIX reference and add note about Windows
tniessen Apr 3, 2017
879ef35
Clarify differences between Windows and POSIX
tniessen Apr 5, 2017
3118594
Simplify sentence
tniessen Apr 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions doc/api/path.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ changes:
* Returns: {string}

The `path.basename()` methods returns the last portion of a `path`, similar to
the Unix `basename` command.
the Unix `basename` command. Trailing directory separators are ignored, see
[`path.sep`][].

For example:

Expand Down Expand Up @@ -128,7 +129,8 @@ changes:
* Returns: {string}

The `path.dirname()` method returns the directory name of a `path`, similar to
the Unix `dirname` command.
the Unix `dirname` command. Trailing directory separators are ignored, see
[`path.sep`][].

For example:

Expand Down Expand Up @@ -347,7 +349,8 @@ added: v0.11.15
* Returns: {Object}

The `path.parse()` method returns an object whose properties represent
significant elements of the `path`.
significant elements of the `path`. Trailing directory separators are ignored,
see [`path.sep`][].

The returned object will have the following properties:

Expand Down Expand Up @@ -523,6 +526,11 @@ On Windows:
// Returns: ['foo', 'bar', 'baz']
```

*Note*: On Windows, both the forward slash (`/`) and backward slash (`\`) are
accepted as path segment separators; however, if separators are to be added by
Windows-specific implementations of the `path` methods, only the backward slash
(`\`) will be used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd change the part after the semicolon to "the path methods only add backward slashes (\)."

"if ... to be ..." is probably hard to follow for people without a good command of English.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, done.


## path.win32
<!-- YAML
added: v0.11.15
Expand All @@ -533,11 +541,8 @@ added: v0.11.15
The `path.win32` property provides access to Windows-specific implementations
of the `path` methods.

*Note*: On Windows, both the forward slash (`/`) and backward slash (`\`)
characters are accepted as path delimiters; however, only the backward slash
(`\`) will be used in return values.

[`path.posix`]: #path_path_posix
[`path.sep`]: #path_path_sep
[`path.win32`]: #path_path_win32
[`path.parse()`]: #path_path_parse_path
[`TypeError`]: errors.html#errors_class_typeerror