doc: include the optional options parameter - #7842
Closed
thefourtheye wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
In the fs docs there's already instances of this with realpath and readlink, and the description goes like this: The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the link path passed to the callback. If the encoding is set to 'buffer', the <thing> returned will be passed as a Buffer object. Does it make sense to go for consistency and do the same here? |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
This generally LGTM but aligning with the other instances for consistency would be good. |
Sorry, something went wrong.
`mkdtemp` functions accept an optional `options` parameter, which can be either a String specifying encoding, or an Object with an `encoding` property.
thefourtheye
force-pushed
the
improve-mkdtemp-doc
branch
from
106c5cd to
51705a1
Compare
August 10, 2016 07:25
Copy link
Copy Markdown
Contributor
Author
|
@claudiorodriguez Updated the PR, with your suggestion. PTAL. |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
LGTM with the updates! |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
ping @claudiorodriguez ... does this LGTY now? |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
Sorry, LGTM |
Sorry, something went wrong.
jasnell
pushed a commit
that referenced
this pull request
Aug 24, 2016
`mkdtemp` functions accept an optional `options` parameter, which can be either a String specifying encoding, or an Object with an `encoding` property. PR-URL: #7842 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Closed
Fishrock123
pushed a commit
to Fishrock123/node
that referenced
this pull request
Sep 8, 2016
`mkdtemp` functions accept an optional `options` parameter, which can be either a String specifying encoding, or an Object with an `encoding` property. PR-URL: nodejs#7842 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Fishrock123
pushed a commit
that referenced
this pull request
Sep 9, 2016
`mkdtemp` functions accept an optional `options` parameter, which can be either a String specifying encoding, or an Object with an `encoding` property. PR-URL: #7842 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Checklist
Affected core subsystem(s)
doc
Description of change
mkdtemp family accepts an optional options parameter, which is
missing in the documentation.
cc @nodejs/documentation