]> Cypherpunks repositories - gostls13.git/commit
cmd/doc: rearrange the newlines to group better
authorRob Pike <r@golang.org>
Fri, 25 Sep 2015 23:04:30 +0000 (16:04 -0700)
committerRob Pike <r@golang.org>
Mon, 28 Sep 2015 16:27:33 +0000 (16:27 +0000)
commitc978f13a71fa7a23a896b34812bbfd6f2e0c1792
tree0a72ba007827b5a360a03698dd26201f5968fbb6
parent12dfc3bee482f16263ce4673a0cce399127e2a0d
cmd/doc: rearrange the newlines to group better

Main change is that the comment for an item no longer has a blank line
before it, so it looks bound to the item it's about.

Motivating example: go doc.io.read changes from

<
func (l *LimitedReader) Read(p []byte) (n int, err error)
func (r *PipeReader) Read(data []byte) (n int, err error)

    Read implements the standard Read interface: it reads data from the pipe,
    blocking until a writer arrives or the write end is closed. If the write end
    is closed with an error, that error is returned as err; otherwise err is
    EOF.
func (s *SectionReader) Read(p []byte) (n int, err error)
>

to

<
func (l *LimitedReader) Read(p []byte) (n int, err error)
func (r *PipeReader) Read(data []byte) (n int, err error)
    Read implements the standard Read interface: it reads data from the pipe,
    blocking until a writer arrives or the write end is closed. If the write end
    is closed with an error, that error is returned as err; otherwise err is
    EOF.

func (s *SectionReader) Read(p []byte) (n int, err error)
>

Now the comment about PipeReader.Read doesn't look like it's about
SectionReader.

Based on a suggestion by dsnet@, a slight tweak from a CL he suggested
and abandoned.

Fixes #12756,

Change-Id: Iaf60ee9ae7f644c83c32d5e130acab0312b0c926
Reviewed-on: https://go-review.googlesource.com/14999
Reviewed-by: Andrew Gerrand <adg@golang.org>
src/cmd/doc/pkg.go