From 0694fb3d78f9ce2add154203dbd42a7a5a07c2da Mon Sep 17 00:00:00 2001
From: Andy Pan <panjf2000@gmail.com>
Date: Tue, 10 Nov 2020 17:56:33 +0800
Subject: [PATCH] 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>
---
 src/image/jpeg/reader.go | 3 ---
 src/image/png/writer.go  | 1 +
 2 files changed, 1 insertion(+), 3 deletions(-)

diff --git a/src/image/jpeg/reader.go b/src/image/jpeg/reader.go
index 4a4706ffe77..b34072396cb 100644
--- 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 53adc1633c0..cbcdb9e7985 100644
--- 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 (