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.

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

Jump to bottom

doc: fix code examples in zlib.md #13342

Closed
wants to merge 3 commits into from
Closed

doc: fix code examples in zlib.md #13342

wants to merge 3 commits into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented May 31, 2017 •
edited
Loading

Checklist
Affected core subsystem(s)

doc, zlib

  • Use test() instead of match() in boolean context.
  • Add spaces in code example.
  • Fix a typo.

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. zlib Issues and PRs related to the zlib subsystem. labels May 31, 2017
@vsemozhetbyt
Copy link
Contributor Author

I am a bit confused about this fragment:

...it is possible to suppress the default error handling by changing the flushing method that is used to compressed the last chunk of input data...

If there is a typo here, let me know how to fix it.

@addaleax
Copy link
Member

@vsemozhetbyt I don’t think there’s a typo in there, but I’d be glad to work out better phrasing if you have ideas or questions?

@mscdex
Copy link
Contributor

mscdex commented May 31, 2017

I think it's supposed to be 'compress' and not 'compressed' in that bolded sentence?

@addaleax
Copy link
Member

Heh. 😄 Sorry, yes, that’s a typo.

@vsemozhetbyt
Copy link
Contributor Author

@addaleax This option is very briefly documented, so I cannot suggest what the right wording would be:

  • 'that is used to compress the last chunk' seems wrong (this is about decompressing, right?)
  • 'that is used to the last compressed chunk' seems a bit shaky.

Is this a right grammar? What does it mean?

@addaleax
Copy link
Member

Yeah, right, it should be decompress instead of compressed. I should take a break, I guess. 😄

@mscdex
Copy link
Contributor

mscdex commented May 31, 2017

@addaleax is right, it should be 'decompress' now that I read the surrounding context.

@mscdex
Copy link
Contributor

mscdex commented May 31, 2017

LGTM

@vsemozhetbyt
Copy link
Contributor Author

Linter CI: https://ci.nodejs.org/job/node-test-linter/9480/

mhdawson
mhdawson approved these changes May 31, 2017
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

@vsemozhetbyt vsemozhetbyt mentioned this pull request Jun 1, 2017
Closed
2 tasks
vsemozhetbyt added a commit that referenced this pull request Jun 2, 2017
@vsemozhetbyt
doc: fix code examples in zlib.md
6cfdbc7 
* Use test() instead of match() in boolean context.
* Add spaces in code example.
* Fix typo.

PR-URL: #13342
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
@vsemozhetbyt
Copy link
Contributor Author

Landed in 6cfdbc7

@vsemozhetbyt vsemozhetbyt deleted the zlib.md branch June 2, 2017 18:57
jasnell pushed a commit that referenced this pull request Jun 5, 2017
@vsemozhetbyt @jasnell
doc: fix code examples in zlib.md
1b192f9 
* Use test() instead of match() in boolean context.
* Add spaces in code example.
* Fix typo.

PR-URL: #13342
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
@jasnell jasnell mentioned this pull request Jun 5, 2017
Closed
@gibfahn gibfahn mentioned this pull request Jun 15, 2017
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mhdawson mhdawson mhdawson approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@addaleax addaleax addaleax approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. zlib Issues and PRs related to the zlib subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@vsemozhetbyt @addaleax @mscdex @jasnell @lpinca @cjihrig @mhdawson @MylesBorins @nodejs-github-bot