all: fix some comments

Change-Id: Ia70b35ab9aef270692a3892629c3c81208771089
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/713360
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Sean Liao <[email protected]>
kokoro-CI: kokoro <[email protected]>
Auto-Submit: Sean Liao <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: David Chase <[email protected]>

Author: cuishuang

deploy/migrate.yaml

@@ -4,7 +4,7 @@
 
 # Run a migrate command on a database
 
-# Required substitions
+# Required substitutions
 # _ENV environment (dev, staging, or prod)
 # _CMD command to migrate
 

internal/config/config.go

@@ -170,7 +170,7 @@ func (c *Config) DBSecondaryConnInfo() string {
 	return c.dbConnInfo(c.DBSecondaryHost)
 }
 
-// dbConnInfo returns a PostgresSQL connection string for the given host.
+// dbConnInfo returns a PostgreSQL connection string for the given host.
 func (c *Config) dbConnInfo(host string) string {
 	// For the connection string syntax, see
 	// https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING.

internal/fetch/fetchdata_test.go

@@ -1398,7 +1398,7 @@ var moduleStd = &testModule{
 						{
 							GOOS:     internal.All,
 							GOARCH:   internal.All,
-							Synopsis: "Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.",
+							Synopsis: "Package context defines the Context type, which carries deadlines, cancellation signals, and other request-scoped values across API boundaries and between processes.",
 							API: []*internal.Symbol{
 								{
 									SymbolMeta: internal.SymbolMeta{

internal/frontend/latest_version_test.go

@@ -54,7 +54,7 @@ func TestLatestMinorVersion(t *testing.T) {
 			name:       "module does not exist",
 			fullPath:   "github.com/mymodule/doesnotexist",
 			modulePath: internal.UnknownModulePath,
-			wantErr:    fmt.Errorf("error while retriving minor version"),
+			wantErr:    fmt.Errorf("error while retrieving minor version"),
 		},
 	}
 	ctx := context.Background()

internal/frontend/markdown.go

@@ -211,7 +211,7 @@ func (e *extractTOC) extract(doc *markdown.Document) {
 		}
 	}
 	if e.removeTitle {
-		// If there is only one top tevel heading with 1 or more children we
+		// If there is only one top level heading with 1 or more children we
 		// assume it is the title of the document and remove it from the TOC.
 		if len(nested) == 1 && len(nested[0].Children) > 0 {
 			nested = nested[0].Children
@@ -359,7 +359,7 @@ func transformHeadingsToHTML(doc *markdown.Document) {
 				htmltag := &markdown.HTMLBlock{}
 				var buf bytes.Buffer
 				// TODO(matloob): Do we want the div and h elements to have analogous classes?
-				// Currently we're using newLevel for the div's class but n.Level for the h element's
+				// Currently we're using newLevel for the div's class but heading.Level for the h element's
 				// class.
 				if newLevel > 6 {
 					fmt.Fprintf(&buf, `<div class="h%d" role="heading" aria-level="%d"`, newLevel, heading.Level)

internal/frontend/search.go

@@ -474,7 +474,7 @@ func shouldDefaultToSymbolSearch(q string) bool {
 		return !internal.TopLevelDomains[parts[len(parts)-1]]
 	}
 	// If a user searches for "Unmarshal", assume that they are searching for
-	// the symbol name "Unmarshal", not the package unmarshal.
+	// the symbol name "Unmarshal", not a package named "unmarshal".
 	return isCapitalized(q)
 }
 

internal/frontend/versions/versions.go

@@ -158,7 +158,7 @@ func buildVersionDetails(ctx context.Context, currentModulePath, packagePath str
 	for _, mi := range modInfos {
 		// Try to resolve the most appropriate major version for this version. If
 		// we detect a +incompatible version (when the path version does not match
-		// the sematic version), we prefer the path version.
+		// the semantic version), we prefer the path version.
 		major := semver.Major(mi.Version)
 		if mi.ModulePath == stdlib.ModulePath {
 			var err error

internal/godoc/dochtml/internal/render/synopsis_test.go

@@ -67,7 +67,7 @@ func TestOneLineNode(t *testing.T) {
 		)
 
 		type Struct struct {
-			// Some commment
+			// Some comment
 
 			// Another comment.
 			Field int

internal/proxy/proxytest/module.go

@@ -20,7 +20,7 @@ type Module struct {
 }
 
 // Some module proxies incorrectly return a space after the version. Tests may
-// simulate that that behavior by giving m.Version a space suffix. This function
+// simulate that behavior by giving m.Version a space suffix. This function
 // will always, however, return the correct form for the version.
 func (m *Module) TidyVersion() string {
 	return strings.TrimSpace(m.Version)

internal/stdlib/testdata/v1.12.5/src/context/context.go

@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 // Package context defines the Context type, which carries deadlines,
-// cancelation signals, and other request-scoped values across API boundaries
+// cancellation signals, and other request-scoped values across API boundaries
 // and between processes.
 //
 // Incoming requests to a server should create a Context, and outgoing
@@ -55,7 +55,7 @@ import (
 	"time"
 )
 
-// A Context carries a deadline, a cancelation signal, and other values across
+// A Context carries a deadline, a cancellation signal, and other values across
 // API boundaries.
 //
 // Context's methods may be called by multiple goroutines simultaneously.
@@ -93,7 +93,7 @@ type Context interface {
 	//  }
 	//
 	// See https://blog.golang.org/pipelines for more examples of how to use
-	// a Done channel for cancelation.
+	// a Done channel for cancellation.
 	Done() <-chan struct{}
 
 	// If Done is not yet closed, Err returns nil.