aboutsummaryrefslogtreecommitdiff
path: root/example_test.go
diff options
context:
space:
mode:
authorSebastiaan van Stijn <[email protected]>2025-09-01 11:58:23 +0200
committerSebastiaan van Stijn <[email protected]>2025-09-01 23:05:22 +0200
commit45a48733e35ba296a5f4dcc2b01996b89dc91a06 (patch)
tree3d5c5850add1ff6bfac8d96e623ccc83b9b31ef3 /example_test.go
parent10438578954bba2527fe5cae3684d4532b064bbe (diff)
fix deprecation comment for (FlagSet.)ParseErrorsWhitelist
Commit 7412009ab0f29ad89cbc6625911a58c0618cf31e added back these types and marked them as deprecated, but did not use the correct format as documented in the [go documentation]. Deprecation comments should be in their own paragraph within the GoDoc, and start with `Deprecated:`, which is case-sensitive. Currently, the deprecation comment is not properly detected, and does not show up as deprecated on [pkg.go.dev]. This patch; - Fixes the deprecation comments to be in the right format. - Updates the GoDoc to use a "docs link" to refer to their replacement, which creates a link to those types on pkg.go.dev. - Adds back GoDoc for the deprecated functions to make sure the GoDoc is in the correct format and keep linters happy. [go documentation]: https://go.dev/doc/comment#deprecations [pkg.go.dev]: https://pkg.go.dev/github.com/spf13/[email protected]#ParseErrorsWhitelist Signed-off-by: Sebastiaan van Stijn <[email protected]>
Diffstat (limited to 'example_test.go')
0 files changed, 0 insertions, 0 deletions