goharbor / goharbor/harbor-cli

enhancement: Command specific doc / description for `opts.Q`

Open
#718 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
163
Forks
211
Avg merge
1m
Merged PRs (30d)
1

Description

Currently the `opts.Q` Flag is very difficult to understand. Even in the goharbor swagger docs the description is not easy to understand.
Coupled with the fact that each command has a new set of `validKeys`.

I wanted to introduce a `BuildQueryParamDocs(vaildKeys []string) string`.
Which will take validKeys and create a multiline string properly formatted with explanation on how each method of querying works.

In this I wanted to know how should I add this? Should it just be like an addition / `sprintf` in the `Long:` in Cobra?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.