Skip to content

Commit 371ae25

Browse files
authored
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 <github@gone.nl>
1 parent e94f6d0 commit 371ae25

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

command.go

+1
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,7 @@ func (c *Command) SetArgs(a []string) {
281281

282282
// SetOutput sets the destination for usage and error messages.
283283
// If output is nil, os.Stderr is used.
284+
//
284285
// Deprecated: Use SetOut and/or SetErr instead
285286
func (c *Command) SetOutput(output io.Writer) {
286287
c.outWriter = output

0 commit comments

Comments
 (0)