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.

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

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

Closed
wants to merge 6 commits into
base: master
from

Conversation

Projects
None yet
8 participants
@sjlehn
Contributor

sjlehn commented Apr 27, 2017

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

Added a note about directory separator conversion under path.posix.

Checklist
Affected core subsystem(s)

doc

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
Show outdated Hide outdated doc/api/path.md Outdated
Show outdated Hide outdated doc/api/path.md Outdated
Show outdated Hide outdated doc/api/path.md Outdated
docs: explain why path.posix.normalize does not replace windows slashes
Move the comment up to the main path.normalize section and fix the
mix-up with / and \

Fixes: #12298
@jasnell

LGTM with a couple of suggestions

Show outdated Hide outdated doc/api/path.md Outdated
Show outdated Hide outdated doc/api/path.md Outdated
@cjihrig

LGTM with @jasnell's comments addressed.

docs: explain why path.posix.normalize does not replace windows slashes
Couple more formatting changes as requested in review: add backticks
to slashes, and add .. to example path.

Fixes: #12298
Show outdated Hide outdated doc/api/path.md Outdated
@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Apr 27, 2017

Member

Typo in the PR and first commit message: POSIX does not recognize / as a valid path separator (should be \).

Member

vsemozhetbyt commented Apr 27, 2017

Typo in the PR and first commit message: POSIX does not recognize / as a valid path separator (should be \).

@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Apr 27, 2017

Member

Linter:

  339:22  error  Strings must use singlequote  quotes
  339:50  error  Missing semicolon             semi
Member

vsemozhetbyt commented Apr 27, 2017

Linter:

  339:22  error  Strings must use singlequote  quotes
  339:50  error  Missing semicolon             semi
Show outdated Hide outdated doc/api/path.md Outdated
docs: explain why path.posix.normalize does not replace windows slashes
Reword note to describe what the method does, rather than what it
doesn't do, per PR feedback

Fixes: #12298
Show outdated Hide outdated doc/api/path.md Outdated
@sjlehn

This comment has been minimized.

Show comment
Hide comment
@sjlehn

sjlehn May 4, 2017

Contributor

@sam-github updated. Anything else I should review, or is it good?

Contributor

sjlehn commented May 4, 2017

@sam-github updated. Anything else I should review, or is it good?

@addaleax

This comment has been minimized.

Show comment
Hide comment
@addaleax

addaleax May 7, 2017

Member

Landed in 9caf78fbaa573bf65f6bbfb27643c072d724481a, fixed up linter errors and commit message while landing. Thanks for the PR! :)

edit: oops, forgot to git add the linter fixes. re-landed in cbd6fde, sorry!

Member

addaleax commented May 7, 2017

Landed in 9caf78fbaa573bf65f6bbfb27643c072d724481a, fixed up linter errors and commit message while landing. Thanks for the PR! :)

edit: oops, forgot to git add the linter fixes. re-landed in cbd6fde, sorry!

@addaleax addaleax closed this May 7, 2017

addaleax added a commit that referenced this pull request May 7, 2017

doc: improve path.posix.normalize docs
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
PR-URL: #12700
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Cai <davidcai1993@yahoo.com>

anchnk added a commit to anchnk/node that referenced this pull request May 19, 2017

doc: improve path.posix.normalize docs
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: nodejs#12298
PR-URL: nodejs#12700
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Cai <davidcai1993@yahoo.com>

@jasnell jasnell referenced this pull request May 11, 2017

Closed

8.0.0 Release Proposal #12220

@gibfahn gibfahn referenced this pull request Jun 15, 2017

Closed

Auditing for 6.11.1 #230

2 of 3 tasks complete

gibfahn added a commit that referenced this pull request Jun 20, 2017

doc: improve path.posix.normalize docs
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
PR-URL: #12700
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Cai <davidcai1993@yahoo.com>

MylesBorins added a commit that referenced this pull request Jul 11, 2017

doc: improve path.posix.normalize docs
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
PR-URL: #12700
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Cai <davidcai1993@yahoo.com>

@MylesBorins MylesBorins referenced this pull request Jul 18, 2017

Merged

v6.11.2 proposal #14356

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment