Update flags descriptions

Amine and Michael Muré created 6 years ago

Enhance printing in prompt

Co-Authored-By: Michael Muré <[e-mail]>

Change summary

bridge/github/config.go      |  4 ++--
bridge/launchpad/config.go   |  4 ++--
commands/bridge_configure.go | 13 +++++++------
3 files changed, 11 insertions(+), 10 deletions(-)

Detailed changes

bridge/github/config.go

@@ -195,8 +195,8 @@ func randomFingerprint() string {
 func promptTokenOptions(owner, project string) (string, error) {
 	for {
 		fmt.Println()
-		fmt.Println("[0]: i have my own token")
-		fmt.Println("[1]: login and generate token")
+		fmt.Println("[0]: user provided token")
+		fmt.Println("[1]: automated token creation")
 		fmt.Print("Select option: ")
 
 		line, err := bufio.NewReader(os.Stdin).ReadString('\n')

bridge/launchpad/config.go

@@ -20,10 +20,10 @@ var (
 
 func (*Launchpad) Configure(repo repository.RepoCommon, params core.BridgeParams) (core.Configuration, error) {
 	if params.Token != "" {
-		fmt.Println("warn: token is not needed to configure a launchpad-preview bridge")
+		fmt.Println("warning: --token is ineffective for a Launchpad bridge")
 	}
 	if params.Owner != "" {
-		fmt.Println("warn: owner is not used when configuring a launchpad-preview bridge")
+		fmt.Println("warning: --owner is ineffective for a Launchpad bridge")
 	}
 
 	conf := make(core.Configuration)

commands/bridge_configure.go

@@ -113,10 +113,11 @@ var bridgeConfigureCmd = &cobra.Command{
 
 func init() {
 	bridgeCmd.AddCommand(bridgeConfigureCmd)
-	bridgeConfigureCmd.Flags().StringVarP(&name, "name", "n", "", "Bridge name")
-	bridgeConfigureCmd.Flags().StringVarP(&target, "target", "t", "", "Bridge target name. Valid values are [github,gitlab,gitea,launchpad-preview]")
-	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.URL, "url", "u", "", "Repository url")
-	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.Owner, "owner", "o", "", "Repository owner")
-	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.Token, "token", "T", "", "Authentication token")
-	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.Project, "project", "p", "", "Repository name")
+	bridgeConfigureCmd.Flags().StringVarP(&name, "name", "n", "", "A distinctive name to identify the bridge")
+	bridgeConfigureCmd.Flags().StringVarP(&target, "target", "t", "",
+		fmt.Sprintf("The target of the bridge. Valid values are [%s]", strings.Join(bridge.Targets(), ",")))
+	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.URL, "url", "u", "", "The URL of the target repository")
+	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.Owner, "owner", "o", "", "The owner of the target repository")
+	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.Token, "token", "T", "", "The authentication token for the API")
+	bridgeConfigureCmd.Flags().StringVarP(&bridgeParams.Project, "project", "p", "", "The name of the target repository")
 }