Switch to godoc-style comments. (#4760)

* Switch to godoc-style comments.

staticcheck cleanup: https://staticcheck.io/docs/checks#ST1021

* Revert spurious diff.
This commit is contained in:
Jacob Hoffman-Andrews 2020-04-08 17:22:40 -07:00 committed by GitHub
parent 4df94d5215
commit b567adb9f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions

View File

@ -577,7 +577,7 @@ type Order struct {
Status AcmeStatus Status AcmeStatus
} }
// SCTDER is a convenience type // SCTDERs is a convenience type
type SCTDERs [][]byte type SCTDERs [][]byte
// CertDER is a convenience type that helps differentiate what the // CertDER is a convenience type that helps differentiate what the

View File

@ -14,22 +14,22 @@ import (
// that a context has already been applied to the relevant DbMap or // that a context has already been applied to the relevant DbMap or
// Transaction object. // Transaction object.
// A `dbOneSelector` is anything that provides a `SelectOne` function. // A OneSelector is anything that provides a `SelectOne` function.
type OneSelector interface { type OneSelector interface {
SelectOne(interface{}, string, ...interface{}) error SelectOne(interface{}, string, ...interface{}) error
} }
// A `Selector` is anything that provides a `Select` function. // A Selector is anything that provides a `Select` function.
type Selector interface { type Selector interface {
Select(interface{}, string, ...interface{}) ([]interface{}, error) Select(interface{}, string, ...interface{}) ([]interface{}, error)
} }
// A `Inserter` is anything that provides an `Insert` function // A Inserter is anything that provides an `Insert` function
type Inserter interface { type Inserter interface {
Insert(list ...interface{}) error Insert(list ...interface{}) error
} }
// A `Execer` is anything that provides an `Exec` function // A Execer is anything that provides an `Exec` function
type Execer interface { type Execer interface {
Exec(string, ...interface{}) (sql.Result, error) Exec(string, ...interface{}) (sql.Result, error)
} }

View File

@ -749,7 +749,7 @@ func (m *Mailer) Connect() error {
return nil return nil
} }
// mockSAWithFailedChallenges is a mocks.StorageAuthority that has // SAWithFailedChallenges is a mocks.StorageAuthority that has
// a `GetAuthorization` implementation that can return authorizations with // a `GetAuthorization` implementation that can return authorizations with
// failed challenges. // failed challenges.
type SAWithFailedChallenges struct { type SAWithFailedChallenges struct {

View File

@ -41,8 +41,8 @@ var (
} }
) )
// It's awkward to work with core.Order or corepb.Order when the API returns // OrderJSON is used because it's awkward to work with core.Order or corepb.Order
// a different object than either of these types can represent without // when the API returns a different object than either of these types can represent without
// converting field values. The WFE uses an unexported `orderJSON` type for the // converting field values. The WFE uses an unexported `orderJSON` type for the
// API results that contain an order. We duplicate it here instead of moving it // API results that contain an order. We duplicate it here instead of moving it
// somewhere exported for this one utility. // somewhere exported for this one utility.