Skip to content

docs: explain why path.posix.normalize does not replace windows slashes #12700

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

Closed
sjlehn wants to merge 6 commits into from
Closed

docs: explain why path.posix.normalize does not replace windows slashes #12700

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c6f50de
docs: explain why path.posix.normalize does not replace windows slashes
sjlehn Apr 27, 2017
91bb7fa
docs: explain why path.posix.normalize does not replace windows slashes
sjlehn Apr 27, 2017
cfaeba4
docs: explain why path.posix.normalize does not replace windows slashes
sjlehn Apr 27, 2017
b4eda57
docs: explain why path.posix.normalize does not replace windows slashes
sjlehn Apr 27, 2017
7dd712f
docs: explain why path.posix.normalize does not replace windows slashes
sjlehn Apr 28, 2017
cb7d451
docs: explain why path.posix.normalize does not replace windows slashes
sjlehn Apr 28, 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
Next Next commit
docs: explain why path.posix.normalize does not replace windows slashes 
Add section to path docs that explains that path.posix.normalize
does not replace Windows slashes with POSIX slashes because POSIX
does not recognize / as a valid path separator.

Fixes: #12298
  • Loading branch information
@sjlehn
sjlehn committed Apr 27, 2017
commit c6f50de6530da6a615a1e575acd59f4ab9677e5f
10 changes: 10 additions & 0 deletions doc/api/path.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,16 @@ added: v0.11.15
The `path.posix` property provides access to POSIX specific implementations
of the `path` methods.

### path.posix.normalize(path)
Copy link
Copy Markdown
Contributor

@cjihrig cjihrig Apr 27, 2017

Choose a reason for hiding this comment

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

I think this note belongs in the normalize() documentation, not as a different subsection in path.posix.

Copy link
Copy Markdown
Contributor Author

@sjlehn sjlehn Apr 27, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Should I still give it a heading or would it be better as just a note after "For Example, on POSIX" at 327

Copy link
Copy Markdown
Contributor

@cjihrig cjihrig Apr 27, 2017

Choose a reason for hiding this comment

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

I wouldn't give it a heading.

The `path.posix.normalize()` method will not attempt to convert / (Windows) to \ (POSIX), as / is not recognized by
Copy link
Copy Markdown
Member

@jasnell jasnell Apr 27, 2017

Choose a reason for hiding this comment

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

long line here. Please line break at 80 chars :-)

POSIX as a valid directory separator.

For example:
```js
path.posix.normalize("/some/thing/like/this")
//Returns '/some/thing/like/this'
```

## path.relative(from, to)
<!-- YAML
added: v0.5.0
Expand Down