-
Notifications
You must be signed in to change notification settings - Fork 2.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify documentation for completion #1310
base: main
Are you sure you want to change the base?
Conversation
I believe the test failures are because of the |
This PR is being marked as stale due to a long period of inactivity |
I forgot about this one. I will rework it. |
Signed-off-by: Marc Khouzam <[email protected]>
8215867
to
99e4b7e
Compare
This documentation-only PR is ready for review @jpmcb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM better late than never.
Run: func(cmd *cobra.Command, args []string) { | ||
RunStatus(args[0]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure why this is changed but it shouldn't matter either way as it is an example only so I am fine with that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was just a cleanup. The example is about the helm status
command but I had left the function call to RunGet
which was a copy/paste from the kubectl get
example.
It was pointed out on Slack that there is no explanation in the docs of what the
toComplete
parameter represents forValidArgsFunction
.This PR explains with examples the
toComplete
and theargs
parameters ofValidArgsFunction
.A section is also added to explain about fuzzy completions.