Clarify documentation for completion #1310
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I believe the test failures are because of the |
Luap99
reviewed
Jan 9, 2021
|
This PR is being marked as stale due to a long period of inactivity |
|
I forgot about this one. I will rework it. |
marckhouzam
added
area/shell-completion
|
|
Signed-off-by: Marc Khouzam <marc.khouzam@gmail.com>
marckhouzam
force-pushed
the
feat/improveDoc
branch
from
8215867
to
99e4b7e
Compare
|
This documentation-only PR is ready for review @jpmcb |
Luap99
approved these changes
Nov 23, 2023
Comment on lines
+177
to
+178
| Run: func(cmd *cobra.Command, args []string) { | ||
| RunStatus(args[0]) |
There was a problem hiding this comment.
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.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It was pointed out on Slack that there is no explanation in the docs of what the
toCompleteparameter represents forValidArgsFunction.This PR explains with examples the
toCompleteand theargsparameters ofValidArgsFunction.A section is also added to explain about fuzzy completions.