From 371ae25d2c82e519feb48c82d142e6a696fd06dd Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 17 Jul 2024 01:36:29 +0200 Subject: [PATCH] Fix deprecation comment for Command.SetOutput (#2172) Deprecation comments should be at the start of a paragraph [1], and because of that have a whitespace above them [2]; > To signal that an identifier should not be used, add a paragraph to its > doc comment that begins with Deprecated: followed by some information > about the deprecation (...) With the whitespace missing, some tools, including pkg.go.dev [3] don't detect it to be deprecated. [1]: https://go.dev/wiki/Deprecated [2]: https://go.dev/doc/comment#paragraphs [3]: https://pkg.go.dev/github.com/spf13/cobra@v1.8.1#Command.SetOutput Signed-off-by: Sebastiaan van Stijn --- command.go | 1 + 1 file changed, 1 insertion(+) diff --git a/command.go b/command.go index 54748fc67..2df6975f9 100644 --- a/command.go +++ b/command.go @@ -281,6 +281,7 @@ func (c *Command) SetArgs(a []string) { // SetOutput sets the destination for usage and error messages. // If output is nil, os.Stderr is used. +// // Deprecated: Use SetOut and/or SetErr instead func (c *Command) SetOutput(output io.Writer) { c.outWriter = output