Skip to content

Commit

Permalink
website: use go.dev instead of outdated golang.org
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandear authored and dominikh committed May 15, 2024
1 parent 0a683c9 commit a6ae5e9
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions stylecheck/st1003/st1003.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ var SCAnalyzer = lint.InitializeAnalyzer(&lint.Analyzer{
See the following links for details:
- https://golang.org/doc/effective_go.html#package-names
- https://golang.org/doc/effective_go.html#mixed-caps
- https://github.com/golang/go/wiki/CodeReviewComments#initialisms
- https://github.com/golang/go/wiki/CodeReviewComments#variable-names`,
- https://go.dev/doc/effective_go#package-names
- https://go.dev/doc/effective_go#mixed-caps
- https://go.dev/wiki/CodeReviewComments#initialisms
- https://go.dev/wiki/CodeReviewComments#variable-names`,
Since: "2019.1",
NonDefault: true,
Options: []string{"initialisms"},
Expand Down
2 changes: 1 addition & 1 deletion stylecheck/st1020/st1020.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If every doc comment begins with the name of the item it describes,
you can use the \'doc\' subcommand of the \'go\' tool and run the output
through grep.
See https://golang.org/doc/effective_go.html#commentary for more
See https://go.dev/doc/effective_go#commentary for more
information on how to write good documentation.`,
Since: "2020.1",
NonDefault: true,
Expand Down
2 changes: 1 addition & 1 deletion stylecheck/st1021/st1021.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If every doc comment begins with the name of the item it describes,
you can use the \'doc\' subcommand of the \'go\' tool and run the output
through grep.
See https://golang.org/doc/effective_go.html#commentary for more
See https://go.dev/doc/effective_go#commentary for more
information on how to write good documentation.`,
Since: "2020.1",
NonDefault: true,
Expand Down
2 changes: 1 addition & 1 deletion stylecheck/st1022/st1022.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If every doc comment begins with the name of the item it describes,
you can use the \'doc\' subcommand of the \'go\' tool and run the output
through grep.
See https://golang.org/doc/effective_go.html#commentary for more
See https://go.dev/doc/effective_go#commentary for more
information on how to write good documentation.`,
Since: "2020.1",
NonDefault: true,
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/checks.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ <h3 id="{{ .name }}">{{ .name }} – {{ .title }}</h3>

{{ template "subcategory-header" (index $categories "ST1") }}
<p>
The rules contained in this category are primarily derived from the <a href="https://github.com/golang/go/wiki/CodeReviewComments">Go wiki</a> and represent community consensus.
The rules contained in this category are primarily derived from the <a href="https://go.dev/wiki/CodeReviewComments">Go wiki</a> and represent community consensus.
</p>

<p>
Expand Down
16 changes: 8 additions & 8 deletions website/data/checks.json
Original file line number Diff line number Diff line change
Expand Up @@ -1850,9 +1850,9 @@
},
"ST1003": {
"Title": "Poorly chosen identifier",
"Text": "Identifiers, such as variable and package names, follow certain rules.\n\nSee the following links for details:\n\n- https://golang.org/doc/effective_go.html#package-names\n- https://golang.org/doc/effective_go.html#mixed-caps\n- https://github.com/golang/go/wiki/CodeReviewComments#initialisms\n- https://github.com/golang/go/wiki/CodeReviewComments#variable-names",
"Text": "Identifiers, such as variable and package names, follow certain rules.\n\nSee the following links for details:\n\n- https://go.dev/doc/effective_go#package-names\n- https://go.dev/doc/effective_go#mixed-caps\n- https://go.dev/wiki/CodeReviewComments#initialisms\n- https://go.dev/wiki/CodeReviewComments#variable-names",
"TitleMarkdown": "Poorly chosen identifier",
"TextMarkdown": "Identifiers, such as variable and package names, follow certain rules.\n\nSee the following links for details:\n\n- https://golang.org/doc/effective_go.html#package-names\n- https://golang.org/doc/effective_go.html#mixed-caps\n- https://github.com/golang/go/wiki/CodeReviewComments#initialisms\n- https://github.com/golang/go/wiki/CodeReviewComments#variable-names",
"TextMarkdown": "Identifiers, such as variable and package names, follow certain rules.\n\nSee the following links for details:\n\n- https://go.dev/doc/effective_go#package-names\n- https://go.dev/doc/effective_go#mixed-caps\n- https://go.dev/wiki/CodeReviewComments#initialisms\n- https://go.dev/wiki/CodeReviewComments#variable-names",
"Before": "",
"After": "",
"Since": "2019.1",
Expand Down Expand Up @@ -2010,9 +2010,9 @@
},
"ST1020": {
"Title": "The documentation of an exported function should start with the function's name",
"Text": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the doc subcommand of the go tool and run the output\nthrough grep.\n\nSee https://golang.org/doc/effective_go.html#commentary for more\ninformation on how to write good documentation.",
"Text": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the doc subcommand of the go tool and run the output\nthrough grep.\n\nSee https://go.dev/doc/effective_go#commentary for more\ninformation on how to write good documentation.",
"TitleMarkdown": "The documentation of an exported function should start with the function's name",
"TextMarkdown": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the `doc` subcommand of the `go` tool and run the output\nthrough grep.\n\nSee https://golang.org/doc/effective_go.html#commentary for more\ninformation on how to write good documentation.",
"TextMarkdown": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the `doc` subcommand of the `go` tool and run the output\nthrough grep.\n\nSee https://go.dev/doc/effective_go#commentary for more\ninformation on how to write good documentation.",
"Before": "",
"After": "",
"Since": "2020.1",
Expand All @@ -2023,9 +2023,9 @@
},
"ST1021": {
"Title": "The documentation of an exported type should start with type's name",
"Text": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the doc subcommand of the go tool and run the output\nthrough grep.\n\nSee https://golang.org/doc/effective_go.html#commentary for more\ninformation on how to write good documentation.",
"Text": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the doc subcommand of the go tool and run the output\nthrough grep.\n\nSee https://go.dev/doc/effective_go#commentary for more\ninformation on how to write good documentation.",
"TitleMarkdown": "The documentation of an exported type should start with type's name",
"TextMarkdown": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the `doc` subcommand of the `go` tool and run the output\nthrough grep.\n\nSee https://golang.org/doc/effective_go.html#commentary for more\ninformation on how to write good documentation.",
"TextMarkdown": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the `doc` subcommand of the `go` tool and run the output\nthrough grep.\n\nSee https://go.dev/doc/effective_go#commentary for more\ninformation on how to write good documentation.",
"Before": "",
"After": "",
"Since": "2020.1",
Expand All @@ -2036,9 +2036,9 @@
},
"ST1022": {
"Title": "The documentation of an exported variable or constant should start with variable's name",
"Text": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the doc subcommand of the go tool and run the output\nthrough grep.\n\nSee https://golang.org/doc/effective_go.html#commentary for more\ninformation on how to write good documentation.",
"Text": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the doc subcommand of the go tool and run the output\nthrough grep.\n\nSee https://go.dev/doc/effective_go#commentary for more\ninformation on how to write good documentation.",
"TitleMarkdown": "The documentation of an exported variable or constant should start with variable's name",
"TextMarkdown": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the `doc` subcommand of the `go` tool and run the output\nthrough grep.\n\nSee https://golang.org/doc/effective_go.html#commentary for more\ninformation on how to write good documentation.",
"TextMarkdown": "Doc comments work best as complete sentences, which\nallow a wide variety of automated presentations. The first sentence\nshould be a one-sentence summary that starts with the name being\ndeclared.\n\nIf every doc comment begins with the name of the item it describes,\nyou can use the `doc` subcommand of the `go` tool and run the output\nthrough grep.\n\nSee https://go.dev/doc/effective_go#commentary for more\ninformation on how to write good documentation.",
"Before": "",
"After": "",
"Since": "2020.1",
Expand Down

0 comments on commit a6ae5e9

Please sign in to comment.