doc: include the optional options parameter #7842

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
5 participants
@thefourtheye
Contributor

thefourtheye commented Jul 22, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

mkdtemp family accepts an optional options parameter, which is
missing in the documentation.


cc @nodejs/documentation

@thefourtheye thefourtheye added the doc label Jul 22, 2016

@claudiorodriguez

This comment has been minimized.

Show comment
Hide comment
@claudiorodriguez

claudiorodriguez Jul 24, 2016

Member

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?

Member

claudiorodriguez commented Jul 24, 2016

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?

@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Aug 5, 2016

Member

This generally LGTM but aligning with the other instances for consistency would be good.

Member

jasnell commented Aug 5, 2016

This generally LGTM but aligning with the other instances for consistency would be good.

doc: include the optional options parameter
`mkdtemp` functions accept an optional `options` parameter, which can
be either a String specifying encoding, or an Object with an `encoding`
property.
@thefourtheye

This comment has been minimized.

Show comment
Hide comment
@thefourtheye

thefourtheye Aug 10, 2016

Contributor

@claudiorodriguez Updated the PR, with your suggestion. PTAL.

Contributor

thefourtheye commented Aug 10, 2016

@claudiorodriguez Updated the PR, with your suggestion. PTAL.

@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Aug 10, 2016

Member

LGTM with the updates!

Member

jasnell commented Aug 10, 2016

LGTM with the updates!

@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Aug 18, 2016

Member

ping @claudiorodriguez ... does this LGTY now?

Member

jasnell commented Aug 18, 2016

ping @claudiorodriguez ... does this LGTY now?

@claudiorodriguez

This comment has been minimized.

Show comment
Hide comment
@claudiorodriguez

claudiorodriguez Aug 19, 2016

Member

Sorry, LGTM

Member

claudiorodriguez commented Aug 19, 2016

Sorry, LGTM

jasnell added a commit that referenced this pull request Aug 24, 2016

doc: include the optional options parameter
`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>
@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Aug 24, 2016

Member

Landed in 6e50fc7

Member

jasnell commented Aug 24, 2016

Landed in 6e50fc7

@jasnell jasnell closed this Aug 24, 2016

@Fishrock123 Fishrock123 referenced this pull request Sep 6, 2016

Closed

v6.6.0 pre-proposal #8428

Fishrock123 added a commit to Fishrock123/node that referenced this pull request Sep 8, 2016

doc: include the optional options parameter
`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 added a commit that referenced this pull request Sep 9, 2016

doc: include the optional options parameter
`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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment