Skip to content

doc: add links for zlib convenience methods #10829

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.

Sign up for GitHub

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

Closed
addaleax wants to merge 2 commits into from
+7 −7
Closed

doc: add links for zlib convenience methods #10829

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7004a3f
doc: add links for zlib convenience methods
addaleax Jan 16, 2017
da99238
[squash] add links for buffer
addaleax Jan 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/api/zlib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ added: v0.6.0
added: v0.11.12
-->

Compress a Buffer or string with Deflate.
Compress a Buffer or string with [Deflate][].
Copy link
Contributor

@danbev danbev Jan 16, 2017

Choose a reason for hiding this comment

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

Should Buffer also be a link?

Copy link
Member Author

@addaleax addaleax Jan 16, 2017

Choose a reason for hiding this comment

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

@danbev I don’t feel very strongly about it, so I’ve gone ahead and added links for the Buffer occurrences.


### zlib.deflateRaw(buf[, options], callback)
<!-- YAML
Expand All @@ -471,7 +471,7 @@ added: v0.6.0
added: v0.11.12
-->

Compress a Buffer or string with DeflateRaw.
Compress a Buffer or string with [DeflateRaw][].

### zlib.gunzip(buf[, options], callback)
<!-- YAML
Expand All @@ -482,7 +482,7 @@ added: v0.6.0
added: v0.11.12
-->

Decompress a Buffer or string with Gunzip.
Decompress a Buffer or string with [Gunzip][].

### zlib.gzip(buf[, options], callback)
<!-- YAML
Expand All @@ -493,7 +493,7 @@ added: v0.6.0
added: v0.11.12
-->

Compress a Buffer or string with Gzip.
Compress a Buffer or string with [Gzip][].

### zlib.inflate(buf[, options], callback)
<!-- YAML
Expand All @@ -504,7 +504,7 @@ added: v0.6.0
added: v0.11.12
-->

Decompress a Buffer or string with Inflate.
Decompress a Buffer or string with [Inflate][].

### zlib.inflateRaw(buf[, options], callback)
<!-- YAML
Expand All @@ -515,7 +515,7 @@ added: v0.6.0
added: v0.11.12
-->

Decompress a Buffer or string with InflateRaw.
Decompress a Buffer or string with [InflateRaw][].

### zlib.unzip(buf[, options], callback)
<!-- YAML
Expand All @@ -526,7 +526,7 @@ added: v0.6.0
added: v0.11.12
-->

Decompress a Buffer or string with Unzip.
Decompress a Buffer or string with [Unzip][].

[`Accept-Encoding`]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
[`Content-Encoding`]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
Expand Down