Skip to content
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

Jump to bottom

doc: add note to util.isBuffer #3790

Merged
merged 1 commit into from
Nov 12, 2015
Merged

doc: add note to util.isBuffer #3790

merged 1 commit into from
Nov 12, 2015

Conversation

evanlucas
Copy link
Contributor

Since util.isBuffer is deprecated, we should be explicit that
Buffer.isBuffer should be used instead.

@mscdex mscdex added util Issues and PRs related to the built-in util module. doc Issues and PRs related to the documentations. labels Nov 12, 2015
@Fishrock123
Copy link
Contributor

LGTM

@Fishrock123
Copy link
Contributor

Of note though, it's just an instanceof check that would probably be more efficient inlined.

@pmq20
Copy link
Contributor

pmq20 commented Nov 12, 2015

Since it's deprecated why still keep the usage description of the old API? Shall we reduce to only the note of "Use Buffer.isBuffer() instead."?

@cjihrig
Copy link
Contributor

cjihrig commented Nov 12, 2015

LGTM. The message might be better with the description of the function, above the code example.

@thefourtheye
Copy link
Contributor

If it is deprecated can we use the stability note like in other functions in it?

@jasnell
Copy link
Member

jasnell commented Nov 12, 2015

LGTM

@evanlucas
Copy link
Contributor Author

@cjihrig are you saying move the note to the top of the section?

@evanlucas
Copy link
Contributor Author

@pmq20 well, it hasn't been removed yet. I think we should keep that part until we actually remove the api

@cjihrig
Copy link
Contributor

cjihrig commented Nov 12, 2015

@evanlucas I meant move it from line 418 to line 407. If you think it would be more likely to be noticed.

@evanlucas
Copy link
Contributor Author

yea, looking back at it, I think that makes more sense

@evanlucas
Copy link
Contributor Author

Updated. PTAL

@cjihrig
Copy link
Contributor

cjihrig commented Nov 12, 2015

LGTM

@evanlucas
doc: add note to util.isBuffer
7cb3a54 
Since util.isBuffer is deprecated, we should be explicit that
Buffer.isBuffer should be used instead.

PR-URL: nodejs#3790
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@evanlucas evanlucas closed this Nov 12, 2015
@evanlucas evanlucas deleted the isbufferdocs branch November 12, 2015 18:48
@evanlucas evanlucas merged commit 7cb3a54 into nodejs:master Nov 12, 2015
@evanlucas
Copy link
Contributor Author

Landed in 7cb3a54. Thanks!

@thefourtheye
Copy link
Contributor

Ah... The deprecation notice is already there. Sorry about the fuss

evanlucas added a commit that referenced this pull request Nov 13, 2015
@evanlucas @rvagg
doc: add note to util.isBuffer
f2c2e53 
Since util.isBuffer is deprecated, we should be explicit that
Buffer.isBuffer should be used instead.

PR-URL: #3790
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
evanlucas added a commit that referenced this pull request Nov 17, 2015
@evanlucas
doc: add note to util.isBuffer
3435f87 
Since util.isBuffer is deprecated, we should be explicit that
Buffer.isBuffer should be used instead.

PR-URL: #3790
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins
Copy link
Contributor

landed in v4.x-staging in 3435f87

@rvagg rvagg mentioned this pull request Nov 17, 2015
Closed
evanlucas added a commit that referenced this pull request Dec 4, 2015
@evanlucas @rvagg
doc: add note to util.isBuffer
e2336f9 
Since util.isBuffer is deprecated, we should be explicit that
Buffer.isBuffer should be used instead.

PR-URL: #3790
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@jasnell jasnell mentioned this pull request Dec 17, 2015
Closed
evanlucas added a commit that referenced this pull request Dec 17, 2015
@evanlucas @jasnell
doc: add note to util.isBuffer
3c415bb 
Since util.isBuffer is deprecated, we should be explicit that
Buffer.isBuffer should be used instead.

PR-URL: #3790
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
evanlucas added a commit that referenced this pull request Dec 23, 2015
@evanlucas @jasnell
doc: add note to util.isBuffer
b92f05a 
Since util.isBuffer is deprecated, we should be explicit that
Buffer.isBuffer should be used instead.

PR-URL: #3790
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. util Issues and PRs related to the built-in util module.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@evanlucas @Fishrock123 @pmq20 @cjihrig @thefourtheye @jasnell @MylesBorins @mscdex