Skip to content

Commit

Permalink
Merge 7d0c53a into cfc6333
Browse files Browse the repository at this point in the history
  • Loading branch information
k1LoW authored Dec 17, 2023
2 parents cfc6333 + 7d0c53a commit cfc3011
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion CREDITS
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Google Style Guides by Google is licensed under CC BY 3.0 (https://creativecommo
================================================================

Go wiki (Go Code Review Comments)
https://github.com/golang/go/wiki (https://github.com/golang/go/wiki/CodeReviewComments)
https://go.dev/wiki (https://go.dev/wiki/CodeReviewComments)
----------------------------------------------------------------
Copyright (c) 2009 The Go Authors. All rights reserved.

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ jobs:

> ["Google Style Guides"](https://google.github.io/styleguide/) by Google is licensed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
### [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) in Go wiki
### [Go Code Review Comments](https://go.dev/wiki/CodeReviewComments) in Go wiki

- [contexts](#contexts) ... based on https://github.com/golang/go/wiki/CodeReviewComments#contexts
- [dontpanic](#dontpanic) ... based on https://github.com/golang/go/wiki/CodeReviewComments#dont-panic
- [errorstrings](#errorstrings) ... based on https://github.com/golang/go/wiki/CodeReviewComments#error-strings
- [handlerrors](#handlerrors) ... based on https://github.com/golang/go/wiki/CodeReviewComments#handle-errors
- [contexts](#contexts) ... based on https://go.dev/wiki/CodeReviewComments#contexts
- [dontpanic](#dontpanic) ... based on https://go.dev/wiki/CodeReviewComments#dont-panic
- [errorstrings](#errorstrings) ... based on https://go.dev/wiki/CodeReviewComments#error-strings
- [handlerrors](#handlerrors) ... based on https://go.dev/wiki/CodeReviewComments#handle-errors

## Disabling and Ignoring

Expand Down
2 changes: 1 addition & 1 deletion _REFERENCE_STYLE_CREDITS
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Google Style Guides by Google is licensed under CC BY 3.0 (https://creativecommo
================================================================

Go wiki (Go Code Review Comments)
https://github.com/golang/go/wiki (https://github.com/golang/go/wiki/CodeReviewComments)
https://go.dev/wiki (https://go.dev/wiki/CodeReviewComments)
----------------------------------------------------------------
Copyright (c) 2009 The Go Authors. All rights reserved.

Expand Down
10 changes: 5 additions & 5 deletions analyzer/code_review_comments/contexts/contexts.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ import (

const (
name = "contexts"
doc = "Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#contexts"
msgp = "Most functions that use a Context should accept it as their first parameter. (ref: https://github.com/golang/go/wiki/CodeReviewComments#contexts )"
msgs = "Don't add a Context member to a struct type; instead add a ctx parameter to each method on that type that needs to pass it along. The one exception is for methods whose signature must match an interface in the standard library or in a third party library. (ref: https://github.com/golang/go/wiki/CodeReviewComments#contexts )"
doc = "Analyzer based on https://go.dev/wiki/CodeReviewComments#contexts"
msgp = "Most functions that use a Context should accept it as their first parameter. (ref: https://go.dev/wiki/CodeReviewComments#contexts )"
msgs = "Don't add a Context member to a struct type; instead add a ctx parameter to each method on that type that needs to pass it along. The one exception is for methods whose signature must match an interface in the standard library or in a third party library. (ref: https://go.dev/wiki/CodeReviewComments#contexts )"
)

var (
Expand All @@ -26,7 +26,7 @@ var (
excludeTest bool
)

// Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#contexts
// Analyzer based on https://go.dev/wiki/CodeReviewComments#contexts
var Analyzer = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand All @@ -37,7 +37,7 @@ var Analyzer = &analysis.Analyzer{
},
}

// AnalyzerWithConfig based on https://github.com/golang/go/wiki/CodeReviewComments#contexts
// AnalyzerWithConfig based on https://go.dev/wiki/CodeReviewComments#contexts
var AnalyzerWithConfig = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand Down
8 changes: 4 additions & 4 deletions analyzer/code_review_comments/dontpanic/dontpanic.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ import (

const (
name = "dontpanic"
doc = "Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#dont-panic"
msg = "Don't use panic for normal error handling. Use error and multiple return values. (ref: https://github.com/golang/go/wiki/CodeReviewComments#dont-panic )"
doc = "Analyzer based on https://go.dev/wiki/CodeReviewComments#dont-panic"
msg = "Don't use panic for normal error handling. Use error and multiple return values. (ref: https://go.dev/wiki/CodeReviewComments#dont-panic )"
)

var (
Expand All @@ -25,7 +25,7 @@ var (
excludeTest bool
)

// Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#dont-panic
// Analyzer based on https://go.dev/wiki/CodeReviewComments#dont-panic
var Analyzer = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand All @@ -36,7 +36,7 @@ var Analyzer = &analysis.Analyzer{
},
}

// AnalyzerWithConfig based on https://github.com/golang/go/wiki/CodeReviewComments#dont-panic
// AnalyzerWithConfig based on https://go.dev/wiki/CodeReviewComments#dont-panic
var AnalyzerWithConfig = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand Down
8 changes: 4 additions & 4 deletions analyzer/code_review_comments/errorstrings/errorstrings.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ import (

const (
name = "errorstrings"
doc = "Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#error-strings"
msg = "Error strings should not be capitalized (unless beginning with proper nouns or acronyms) or end with punctuation, since they are usually printed following other context. (ref: https://github.com/golang/go/wiki/CodeReviewComments#error-strings )"
doc = "Analyzer based on https://go.dev/wiki/CodeReviewComments#error-strings"
msg = "Error strings should not be capitalized (unless beginning with proper nouns or acronyms) or end with punctuation, since they are usually printed following other context. (ref: https://go.dev/wiki/CodeReviewComments#error-strings )"
)

var (
Expand All @@ -26,7 +26,7 @@ var (
excludeTest bool
)

// Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#error-strings
// Analyzer based on https://go.dev/wiki/CodeReviewComments#error-strings
var Analyzer = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand All @@ -37,7 +37,7 @@ var Analyzer = &analysis.Analyzer{
},
}

// AnalyzerWithConfig based on https://github.com/golang/go/wiki/CodeReviewComments#error-strings
// AnalyzerWithConfig based on https://go.dev/wiki/CodeReviewComments#error-strings
var AnalyzerWithConfig = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand Down
8 changes: 4 additions & 4 deletions analyzer/code_review_comments/handlerrors/handlerrors.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ import (

const (
name = "handlerrors"
doc = "Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#handle-errors"
msg = "Do not discard errors using `_` variables. If a function returns an error, check it to make sure the function succeeded. Handle the error, return it, or, in truly exceptional situations, panic. (ref: https://github.com/golang/go/wiki/CodeReviewComments#handle-errors )"
doc = "Analyzer based on https://go.dev/wiki/CodeReviewComments#handle-errors"
msg = "Do not discard errors using `_` variables. If a function returns an error, check it to make sure the function succeeded. Handle the error, return it, or, in truly exceptional situations, panic. (ref: https://go.dev/wiki/CodeReviewComments#handle-errors )"
)

var (
Expand All @@ -26,7 +26,7 @@ var (
excludeTest bool
)

// Analyzer based on https://github.com/golang/go/wiki/CodeReviewComments#handle-errors
// Analyzer based on https://go.dev/wiki/CodeReviewComments#handle-errors
var Analyzer = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand All @@ -37,7 +37,7 @@ var Analyzer = &analysis.Analyzer{
},
}

// AnalyzerWithConfig based on https://github.com/golang/go/wiki/CodeReviewComments#handle-errors
// AnalyzerWithConfig based on https://go.dev/wiki/CodeReviewComments#handle-errors
var AnalyzerWithConfig = &analysis.Analyzer{
Name: name,
Doc: doc,
Expand Down

0 comments on commit cfc3011

Please sign in to comment.