doc: specify options parameter type in zlib.md
#21920
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
vsemozhetbyt
added
doc
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
lpinca
reviewed
Jul 21, 2018
doc/api/zlib.md
Outdated
| @@ -505,45 +505,45 @@ that effectively uses an 8-bit window only. | |||
| added: v0.5.8 | |||
| --> | |||
|
|
|||
| * `options` {Object} | |||
| * `options` {zlib.Options} | |||
There was a problem hiding this comment.
Hmm, this makes me think that zlib.Options is a constructor I have to instantiate instead of a plain object. I have to click the link to understand that in reality is a plain object.
There was a problem hiding this comment.
Commit amended. Would it be better in this way?
There was a problem hiding this comment.
Yes, I think it's better. Thanks.
There was a problem hiding this comment.
We have something similar for http2:
Also, delete now redundant notes and links.
lpinca
approved these changes
Jul 21, 2018
trivikr
approved these changes
Jul 22, 2018
|
Landed in 811598b |
vsemozhetbyt
added a commit
that referenced
this pull request
Jul 24, 2018
Also, delete now redundant notes and links. PR-URL: #21920 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
|
Depends on #21782 to land on |
targos
pushed a commit
that referenced
this pull request
Aug 7, 2018
Also, delete now redundant notes and links. PR-URL: #21920 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This was referenced Aug 16, 2018
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.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAlso, delete now redundant notes and links.