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>
golang · Feb 24, 2021 · 0694fb3 · 0694fb3
1 parent 6cc8aa7
commit 0694fb3
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 3 deletions.
diff --git 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
@@ -51,6 +51,7 @@ type encoder struct {
 	bw      *bufio.Writer
 }
 
+// CompressionLevel indicates the compression level.
 type CompressionLevel int
 
 const (
-Original file line number
+Diff line change
@@ Expand Up / @@ -51,6 +51,7 @@ type encoder struct { @@
     	bw      *bufio.Writer
     }
+    // CompressionLevel indicates the compression level.
     type CompressionLevel int
     const (
@@ Expand Down @@