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: add docs for Zlib#close() #16592

Closed
wants to merge 0 commits into from

Conversation

Projects
None yet
9 participants
@lpinca
Copy link
Member

commented Oct 29, 2017

Add docs for Zlib.prototype.close().

Checklist
Affected core subsystem(s)

doc

@gireeshpunathil
Copy link
Member

left a comment

On a side note, I see API docs (inconsistently) use statements that are in:
imperative mood such as
Compress a chunk of data with Gzip.
and declarative mood such as
Creates and returns a new Deflate object with the given options.

probably makes sense to unify them (I like the declarative style), a future code-and-learn candidate?

@daxlab

This comment has been minimized.

Copy link
Member

commented Oct 30, 2017

+1 @gireeshpunathil

@daxlab

daxlab approved these changes Oct 30, 2017

lpinca added a commit that referenced this pull request Nov 3, 2017

doc: add docs for Zlib#close()
PR-URL: #16592
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

@lpinca lpinca closed this Nov 3, 2017

@lpinca lpinca force-pushed the lpinca:add/docs-for-zlib-close branch from fb2d28b to 562ea89 Nov 3, 2017

@lpinca

This comment has been minimized.

Copy link
Member Author

commented Nov 3, 2017

Landed in 562ea89.

@lpinca lpinca deleted the lpinca:add/docs-for-zlib-close branch Nov 3, 2017

cjihrig added a commit to cjihrig/node-1 that referenced this pull request Nov 6, 2017

doc: add docs for Zlib#close()
PR-URL: nodejs#16592
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

@cjihrig cjihrig referenced this pull request Nov 6, 2017

Merged

v9.1.0 proposal #16851

MylesBorins added a commit that referenced this pull request Nov 14, 2017

doc: add docs for Zlib#close()
PR-URL: #16592
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

gibfahn added a commit that referenced this pull request Nov 14, 2017

doc: add docs for Zlib#close()
PR-URL: #16592
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

@MylesBorins MylesBorins referenced this pull request Nov 21, 2017

Merged

v6.12.1 proposal #17180

@gibfahn gibfahn referenced this pull request Nov 21, 2017

Merged

v8.9.2 proposal #17204

msoechting added a commit to hpicgs/node that referenced this pull request Feb 7, 2018

doc: add docs for Zlib#close()
PR-URL: nodejs#16592
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.