Skip to content

Commit

Permalink
Fix Command.Context comment (#1639)
Browse files Browse the repository at this point in the history
  • Loading branch information
katexochen committed Mar 21, 2022
1 parent f848943 commit 3a1795b
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions command.go
Expand Up @@ -166,7 +166,7 @@ type Command struct {
// errWriter is a writer defined by the user that replaces stderr
errWriter io.Writer

//FParseErrWhitelist flag parse errors to be ignored
// FParseErrWhitelist flag parse errors to be ignored
FParseErrWhitelist FParseErrWhitelist

// CompletionOptions is a set of options to control the handling of shell completion
Expand Down Expand Up @@ -224,8 +224,13 @@ type Command struct {
SuggestionsMinimumDistance int
}

// Context returns underlying command context. If command wasn't
// executed with ExecuteContext Context returns Background context.
// Context returns underlying command context. If command was executed
// with ExecuteContext or the context was set with SetContext, the
// previously set context will be returned. Otherwise, nil is returned.
//
// Notice that a call to Execute and ExecuteC will replace a nil context of
// a command with a context.Background, so a background context will be
// returned by Context after one of these functions has been called.
func (c *Command) Context() context.Context {
return c.ctx
}
Expand Down

0 comments on commit 3a1795b

Please sign in to comment.