doc: clarity type of first argument in zlib - #5685
Closed
fanatid wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
LGTM. Two tiny improvements I can think of to clarify it further would be to capitalize the B in Buffer, and, in the text "All of these take a string or buffer as the first argument", link the word "Buffer" to the buffer doc page. |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
LGTM |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
PS tiny tiny nit, commit message should be: doc: clarify type of first argument in zlib The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. This can be changed while merging though. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
updated (commit message) |
Sorry, something went wrong.
The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`.
claudiorodriguez
pushed a commit
that referenced
this pull request
Mar 15, 2016
The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. PR-URL: #5685 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas
pushed a commit
that referenced
this pull request
Mar 15, 2016
The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. PR-URL: #5685 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
rvagg
pushed a commit
that referenced
this pull request
Mar 16, 2016
The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. PR-URL: #5685 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 17, 2016
The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. PR-URL: #5685 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 21, 2016
The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. PR-URL: #5685 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 21, 2016
The current documentation for Convenience Methods specifies that the first argument can be either `string or buffer`, `string` or `raw Buffer`. This commit replaces all these instances with `Buffer or string`. PR-URL: #5685 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.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
4 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.
The current documentation for Convenience Methods specify that first argument can be string or buffer, string or raw Buffer.
This PR replace string and raw Buffer to string or buffer.