/cc @dsnet.

@willfaught we recently added some examples to tip https://tip.golang.org/pkg/compress/gzip/#pkg-examples so they won't yet be on https://golang.org until the next major release, so for now perhaps that could be of use, before documentation for that method is in?

Thanks. I think I figured it out, but it'll help the next person.

By examples, do you mean actual worded documentation like the rest of the methods there, or code in a doc comment, or actual example functions?

On Oct 6, 2016, at 11:30 PM, Emmanuel T Odeke notifications@github.com wrote:

/cc @dsnet.

@willfaught we recently added some examples to tip https://tip.golang.org/pkg/compress/gzip/#Reader.Read so they won't yet be on https://golang.org until the next major release, so for now perhaps that could be of use, before documentation for that method is in?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

By examples, I meant snippets of runnable code in the godoc.

OK

I think Read should still have its own proper godoc comment like the other methods.

On Oct 7, 2016, at 12:39 AM, Emmanuel T Odeke notifications@github.com wrote:

By examples, I meant snippets of runnable code in the godoc.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

We often don't document implementations of common interface methods, unless there's something notable to say.

Does this reader do something special over a typical io.Reader?

Does this reader do something special over a typical io.Reader?

Nope.

I'm not opposed to documenting it either, though.

@odeke-em, want to write a single documentation sentence for it?

@dsnet thanks. For sure I'd love to do that. If it is urgent please go ahead and add it, otherwise I'll be able to submit a patch in about 9 hours when am back home from work.

I was unsure at first whether this Read read into or out of the param. The two Readers involved confused me. In that context, I didn't recognize it as an io.Reader.Read method. Makes sense when you recognize that.

On Oct 7, 2016, at 8:03 AM, Brad Fitzpatrick notifications@github.com wrote:

We often don't document implementations of common interface methods, unless there's something notable to say.

Does this reader do something special over a typical io.Reader?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

CL https://golang.org/cl/30718 mentions this issue.