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.

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

Closed
wants to merge 1 commit into from
Closed

doc: specify options parameter type in zlib.md #21920

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Also, delete now redundant notes and links.

@vsemozhetbyt vsemozhetbyt added doc Issues and PRs related to the documentations. zlib Issues and PRs related to the zlib subsystem. tools Issues and PRs related to the tools directory. labels Jul 21, 2018
@vsemozhetbyt
Copy link
Contributor Author

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}
Copy link
Member

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.

Copy link
Contributor Author

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?

Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, delete now redundant notes and links.
@vsemozhetbyt
Copy link
Contributor Author

@vsemozhetbyt
Copy link
Contributor Author

Landed in 811598b
Thank you for the reviews.

@vsemozhetbyt vsemozhetbyt deleted the doc-zlib-options-type branch July 24, 2018 14:02
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>
@targos
Copy link
Member

targos commented Jul 24, 2018

Depends on #21782 to land on v10.x-staging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. zlib Issues and PRs related to the zlib subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants