image: resolve the TODO of doc comment style

Change-Id: Ic7701a9e4635fe1a331c9a1df776ed580759eb9d
Reviewed-on: https://go-review.googlesource.com/c/go/+/268758
Reviewed-by: Nigel Tao <nigeltao@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
Trust: Nigel Tao <nigeltao@golang.org>
Trust: Alberto Donizetti <alb.donizetti@gmail.com>
Trust: Rob Pike <r@golang.org>

diff --git a/src/image/jpeg/reader.go b/src/image/jpeg/reader.go
index 4a4706ffe7727333fd56778f549030d3b2a26d12..b34072396cbefaf464b7525f179315a1d142424b 100644 (file)
--- a/src/image/jpeg/reader.go
+++ b/src/image/jpeg/reader.go
@@ -14,9 +14,6 @@ import (
        "io"
 )
 
-// TODO(nigeltao): fix up the doc comment style so that sentences start with
-// the name of the type or function that they annotate.
-
 // A FormatError reports that the input is not a valid JPEG.
 type FormatError string
 

diff --git a/src/image/png/writer.go b/src/image/png/writer.go
index 53adc1633c0dba6a7e82b19fc9b898d1c222d1ba..cbcdb9e798519488c1a5925968a9661230b60460 100644 (file)
--- a/src/image/png/writer.go
+++ b/src/image/png/writer.go
@@ -51,6 +51,7 @@ type encoder struct {
        bw      *bufio.Writer
 }
 
+// CompressionLevel indicates the compression level.
 type CompressionLevel int
 
 const (