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

Extend MultiGzDecoder docs #94

Merged
merged 1 commit into from
Apr 11, 2017
Merged

Conversation

veldsla
Copy link
Contributor

@veldsla veldsla commented Apr 11, 2017

This PR adds an explanation to the MultiGzDecoder. Love the wording in the evaluation 😄

I didn't know what a gzip multistream is so I searched for "gzip multistream" and landed on the Go gzip package's documentation which explained everything I needed to know. Then I felt dirty.

In my defense 😉 I picked the multistream term because it was in the Go docs, my personal preference was MultiMember. We can of course still change this!

I'm a bit uncertain if I should refer to the public name MultiGzDecoder, or the internal name MultiDecoderReader, but this is also related to #75.

This fixes #87.

@alexcrichton
Copy link
Member

Awesome, thanks @veldsla!

@alexcrichton alexcrichton merged commit 06b8e3f into rust-lang:master Apr 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explain what a gzip multistream means
2 participants