Skip to content

Commit

Permalink
Change generated code comment to match common Go
Browse files Browse the repository at this point in the history
According to https://golang.org/s/generatedcode the generated
Go code should have a comment matches the following regexp:
```
^// Code generated .* DO NOT EDIT\.$
```
  • Loading branch information
alexandear committed Feb 17, 2023
1 parent 1505d28 commit c02dd54
Show file tree
Hide file tree
Showing 15 changed files with 17 additions and 14 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add `String` method to `atomic.Pointer[T]` type allowing users to safely print
underlying values of pointers.

### Changed
- Change a comment that marks generated Go code. Now it matches the regexp `^// Code generated .* DO NOT EDIT\.$` according to common Go standard.

## [1.10.0] - 2022-08-11
### Added
- Add `atomic.Float32` type for atomic operations on `float32`.
Expand Down
2 changes: 1 addition & 1 deletion bool.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion duration.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion error.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion float32.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion float64.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion int32.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion int64.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/gen-atomicint/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ func run(args []string) error {
return fmt.Errorf("reformat source: %v", err)
}

io.WriteString(w, "// @generated Code generated by gen-atomicint.\n\n")
io.WriteString(w, "// Code generated by gen-atomicint. DO NOT EDIT.\n\n")
_, err = w.Write(bs)
return err
}
Expand Down
2 changes: 1 addition & 1 deletion internal/gen-atomicwrapper/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ func run(args []string) error {
return fmt.Errorf("reformat source: %v", err)
}

io.WriteString(w, "// @generated Code generated by gen-atomicwrapper.\n\n")
io.WriteString(w, "// Code generated by gen-atomicwrapper. DO NOT EDIT.\n\n")
_, err = w.Write(bs)
return err
}
Expand Down
2 changes: 1 addition & 1 deletion string.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion time.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion uint32.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion uint64.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion uintptr.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c02dd54

Please sign in to comment.