From 817897f891a8bc2ddaca42bc58788407abf52a2a Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sat, 1 Apr 2023 18:16:52 +0200 Subject: [PATCH] cli/command: fix deprecation comments for Stream types These were deprecated in 6c400a9c2009bba9376ad61ab59c04c1ad675871 (docker 19.03), but the "Deprecated:" comments were missing a newline before them. While most IDEs will detect such comments as "deprecated", pkg.go.dev and linters will ignore them, which may result in users not being aware of them being deprecated. This patch; - Fixes the "Deprecated:" comments. - Changes the var aliases to functions, which is slightly more boilerplating, but makes sure the functions are documented as "function", instead of shown in the "variables" section on pkg.go.dev. - Adds some punctuation and adds "doc links", which allows readers to navigate to related content on pkg.go.dev. Signed-off-by: Sebastiaan van Stijn --- cli/command/streams.go | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/cli/command/streams.go b/cli/command/streams.go index fa435e1643..43dc6cd00e 100644 --- a/cli/command/streams.go +++ b/cli/command/streams.go @@ -1,23 +1,32 @@ package command import ( + "io" + "github.com/docker/cli/cli/streams" ) // InStream is an input stream used by the DockerCli to read user input -// Deprecated: Use github.com/docker/cli/cli/streams.In instead +// +// Deprecated: Use [streams.In] instead. type InStream = streams.In // OutStream is an output stream used by the DockerCli to write normal program // output. -// Deprecated: Use github.com/docker/cli/cli/streams.Out instead +// +// Deprecated: Use [streams.Out] instead. type OutStream = streams.Out -var ( - // NewInStream returns a new InStream object from a ReadCloser - // Deprecated: Use github.com/docker/cli/cli/streams.NewIn instead - NewInStream = streams.NewIn - // NewOutStream returns a new OutStream object from a Writer - // Deprecated: Use github.com/docker/cli/cli/streams.NewOut instead - NewOutStream = streams.NewOut -) +// NewInStream returns a new [streams.In] from an [io.ReadCloser]. +// +// Deprecated: Use [streams.NewIn] instead. +func NewInStream(in io.ReadCloser) *streams.In { + return streams.NewIn(in) +} + +// NewOutStream returns a new [streams.Out] from an [io.Writer]. +// +// Deprecated: Use [streams.NewOut] instead. +func NewOutStream(out io.Writer) *streams.Out { + return streams.NewOut(out) +}