STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add godoc comments to exported symbols in remaining packages

Browse source 
Add documentation comments to exported symbols across all remaining
smaller packages including cmd/gen-docs, context, internal/browser,
internal/gh, internal/ghcmd, internal/ghinstance, internal/ghrepo,
internal/keyring, internal/run, internal/safepaths, internal/tableprinter,
internal/text, internal/update, pkg/cmd/accessibility, pkg/cmd/actions,
pkg/cmd/alias, pkg/cmd/api, pkg/cmd/browse, pkg/cmd/cache,
pkg/cmd/completion, pkg/cmd/copilot, pkg/cmd/factory, pkg/cmd/gpg-key,
pkg/cmd/label, pkg/cmd/licenses, pkg/cmd/org, pkg/cmd/preview,
pkg/cmd/ssh-key, pkg/cmd/version, pkg/extensions, pkg/jsoncolor,
pkg/markdown, pkg/option, pkg/set, pkg/ssh, pkg/surveyext, test,
internal/authflow, and utils.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Kynan Ware 2026-03-04 16:14:20 -07:00
parent df295a1dba
commit b8ee5c5eba
66 changed files with 178 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
internal/keyring/keyring.go
View file

@ -8,12 +8,15 @@ import (
"github.com/zalando/go-keyring"
)
// ErrNotFound is returned when a keyring entry is not found.
var ErrNotFound = errors.New("secret not found in keyring")
// TimeoutError represents an error returned by the operation.
type TimeoutError struct {
message string
}
// Error returns the error message for TimeoutError.
func (e *TimeoutError) Error() string {
return e.message
}
@ -73,10 +76,12 @@ func Delete(service, user string) error {
}
}
// MockInit sets up a mock keyring for testing.
func MockInit() {
keyring.MockInit()
}
// MockInitWithError sets up a mock keyring that returns the given error.
func MockInitWithError(err error) {
keyring.MockInitWithError(err)
}