Remove 'Auto generated by spf13/cobra' message from documentation output - #3
Remove 'Auto generated by spf13/cobra' message from documentation output#3meekrosoft wants to merge 2 commits into
Conversation
| -h, --help help for k8s | ||
| -i, --id string The unique identifier of the source infrastructure of the report (e.g. the K8S cluster/namespace name). If not set, it is defaulted to environment name. | ||
| -k, --kubeconfig string The kubeconfig path for the target cluster. (default "$HOME/.kube/config") | ||
| -k, --kubeconfig string The kubeconfig path for the target cluster. (default "/Users/mikelong/.kube/config") |
There was a problem hiding this comment.
since this is auto generated maybe we don't need to care about that, but how did your $HOME ended up here?? 🤔
There was a problem hiding this comment.
Interesting...I've no idea actually
There was a problem hiding this comment.
I've reverted this manually, but we should figure out if there is a better way than manually doing this.
There was a problem hiding this comment.
the default path is generated dynamically when the binary runs (and docs are generated by running a command from the binary). That's fine for the help text because you get a personalized default printed. But we need to make sure it's left as $HOME when we generate docs. We can set a DEV env variable in the make file and don't find the actual home dir when that variable is set to true.
ewelinawilkosz
left a comment
ewelinawilkosz
left a comment
There was a problem hiding this comment.
except the one comment about a path in generated file it looks good
| Long: globalUsage, | ||
| SilenceUsage: true, | ||
| TraverseChildren: true, | ||
| DisableAutoGenTag: true, |
There was a problem hiding this comment.
this is the only line you need to disable the autogen tag. Since this is the root command, all others will respect this without explicitly setting it on each of them.
3 participants
No description provided.