docs(completion): shorten completer doc comments

Signed-off-by: bircni <bircni@icloud.com>
This commit is contained in:
bircni committed 2026-10-12 20:48:00 +02:00
1 parent fa9cb4f852
commit f783de3564
1 file changed
+5 -8
+5 -8
View File
@@ -268,10 +268,9 @@ func (a *application) completeConfig(cmd *cobra.Command, args []string, toComple
return matching(configValues[args[0]], toComplete), cobra.ShellCompDirectiveNoFileComp return matching(configValues[args[0]], toComplete), cobra.ShellCompDirectiveNoFileComp
} }
// apiCompletion completes the values that list fetches from the selected instance; requireRepo // apiCompletion completes the values that list fetches from the selected instance, except those
// selects whether list needs a repository. It never prompts, refreshes an OAuth token or retries, // already given. It never prompts, refreshes or retries, and failures complete nothing rather than
// and gives up after completionTimeout: failures complete nothing rather than file names. Values // file names.
// already given as arguments are not offered again.
func (a *application) apiCompletion(requireRepo bool, list func(ctx context.Context, t target, toComplete string) ([]cobra.Completion, error)) cobra.CompletionFunc { func (a *application) apiCompletion(requireRepo bool, list func(ctx context.Context, t target, toComplete string) ([]cobra.Completion, error)) cobra.CompletionFunc {
return func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) { return func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
ctx, cancel := completionContext(cmd) ctx, cancel := completionContext(cmd)
@@ -489,8 +488,7 @@ func (a *application) completeRuns() cobra.CompletionFunc {
}) })
} }
// completeSecrets completes Actions secret names in the scope that scope selects; a scope without an // completeSecrets completes Actions secret names in the selected scope.
// organization or account selects the repository.
func (a *application) completeSecrets(scope func() services.ActionScope) cobra.CompletionFunc { func (a *application) completeSecrets(scope func() services.ActionScope) cobra.CompletionFunc {
return a.apiCompletion(true, func(ctx context.Context, t target, _ string) ([]cobra.Completion, error) { return a.apiCompletion(true, func(ctx context.Context, t target, _ string) ([]cobra.Completion, error) {
items, err := services.ActionSecrets{Client: t.client, Scope: actionScope(scope, t)}.ListPage(ctx, completionLimit, 1) items, err := services.ActionSecrets{Client: t.client, Scope: actionScope(scope, t)}.ListPage(ctx, completionLimit, 1)
@@ -498,8 +496,7 @@ func (a *application) completeSecrets(scope func() services.ActionScope) cobra.C
}) })
} }
// completeVariables completes Actions variable names in the scope that scope selects; a scope without // completeVariables completes Actions variable names in the selected scope.
// an organization or account selects the repository.
func (a *application) completeVariables(scope func() services.ActionScope) cobra.CompletionFunc { func (a *application) completeVariables(scope func() services.ActionScope) cobra.CompletionFunc {
return a.apiCompletion(true, func(ctx context.Context, t target, _ string) ([]cobra.Completion, error) { return a.apiCompletion(true, func(ctx context.Context, t target, _ string) ([]cobra.Completion, error) {
items, err := services.ActionVariables{Client: t.client, Scope: actionScope(scope, t)}.ListPage(ctx, completionLimit, 1) items, err := services.ActionVariables{Client: t.client, Scope: actionScope(scope, t)}.ListPage(ctx, completionLimit, 1)