-
Notifications
You must be signed in to change notification settings - Fork 29k
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.
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
doc: specify options
parameter type in zlib.md
#21920
Conversation
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Commit amended. Would it be better in this way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think it's better. Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have something similar for http2
:
Also, delete now redundant notes and links.
Landed in 811598b |
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 |
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>
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesAlso, delete now redundant notes and links.