doc: explain path.format() algorithm #5688
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Trott
added
doc
|
LGTM |
|
LGTM |
| Returns a path string from an object, the opposite of [`path.parse`][]. | ||
| Returns a path string from an object. This is the opposite of [`path.parse`][]. | ||
|
|
||
| If `pathObject` has all expected properties, the returned string will be a |
There was a problem hiding this comment.
May want to expand on this just a bit to say what all the expected properties are up front.
|
Generally LGTM with some nits. |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Mar 16, 2016
PR-URL: nodejs#5688 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com> Fixes: nodejs#2305
|
Landed in a97dfa0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Affected core subsystem(s)
doc
Description of change
Explain how
path.format()behaves whenpathObjectis incomplete. Last remaining fix to close #2305/cc @nodejs/documentation @sam-github @reggi