From b7ff44c678e0dd05ec229d37e708e99de9ec2053 Mon Sep 17 00:00:00 2001 From: Hosh Sadiq Date: Tue, 3 Jan 2023 02:16:25 +0000 Subject: [PATCH] Update CompletionOptions documentation to struct doc for accuracy --- site/content/completions/completion.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/site/content/completions/completion.md b/site/content/completions/completion.md index eca0d58..2837a33 100644 --- a/site/content/completions/completion.md +++ b/site/content/completions/completion.md @@ -24,24 +24,13 @@ Zulu's completion scripts provide the following features: Zulu provides a few options for the default `completion` command. To configure such options you must set the `CompletionOptions` field on the *root* command. -To tell Zulu *not* to provide the default `completion` command: -``` -rootCmd.CompletionOptions.DisableDefaultCmd = true -``` - -To tell Zulu *not* to provide the user with the `--no-descriptions` flag to the completion sub-commands: -``` -rootCmd.CompletionOptions.DisableNoDescFlag = true -``` - -To tell Zulu to completely disable descriptions for completions: -``` -rootCmd.CompletionOptions.DisableDescriptions = true -``` +Please look at the documentation for the [`CompletionOptions](https://pkg.go.dev/github.com/zulucmd/zulu#CompletionOptions) struct to see what can be configured. ## Customizing completions -The generated completion scripts will automatically handle completing commands and flags. However, you can make your completions much more powerful by providing information to complete your program's nouns and flag values. +The generated completion scripts will automatically handle completing commands and flags. +However, you can make your completions much more powerful by providing information to +complete your program's nouns and flag values. ### Completion of nouns