Tune flag type for component references #213
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tengqm The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
approved
|
Hi @tengqm . |
|
Yes. This PR changes the data type presentation so that readers will see |
gen-compdocs/generators/doc.go
Outdated
| name = "<a string in the form 'file:N'>" | ||
| } | ||
|
|
||
| fmt.Printf("type name = %s\n", name) |
There was a problem hiding this comment.
Do you want to keep this line?
https://travis-ci.org/github/kubernetes-sigs/reference-docs/builds/760101045
There was a problem hiding this comment.
oh ... no. Will remove.
The current generator exposes GoLang specific data types for command line arguments, e.g. `stringSlice`, `stringArray`, `mapStringString`. These type name come from the pflags package and they fail to accurately document the actual type of arguments for users to specify from command line. This PR fixes this problem by replacing these data type names with a descriptive text where appropriate so that users have a better idea what are expected by each flag.
|
Thanks @tengqm . |
k8s-ci-robot
added
the
lgtm
3 participants
The current generator exposes GoLang specific data types for command line arguments, e.g.
stringSlice,stringArray,mapStringString. These type name come from the pflags package and they fail to accurately document the actual type of arguments for users to specify from command line.This PR fixes this problem by replacing these data type names with a descriptive text where appropriate so that users have a better idea what are expected by each flag.