Updated help messages #311

brunats · 2020-07-24T20:36:16Z

- What I did

Updated help messages for core commands and commands with more than one subcommand.
This PR includes PR #256 changes for the ritchie-2.0.0 branch

Core

->

Completion

->

Delete

->

Set

->

- How to verify it

rit # to verify help messages of commands core
rit completion
rit delete
rit set

- Description for the changelog

Updated help messages

codecov-commenter · 2020-07-24T20:39:11Z

Codecov Report

❗ No coverage uploaded for pull request base (ritchie-2.0.0@a0beb5a). Click here to learn what that means.
The diff coverage is n/a.

@@               Coverage Diff                @@
##             ritchie-2.0.0     #311   +/-   ##
================================================
  Coverage                 ?   57.01%           
================================================
  Files                    ?       70           
  Lines                    ?     2275           
  Branches                 ?        0           
================================================
  Hits                     ?     1297           
  Misses                   ?      827           
  Partials                 ?      151

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a0beb5a...04b4392. Read the comment docs.

…lete

sandokandias · 2020-07-27T17:10:41Z

functional/core/core_feature.json

@@ -224,7 +224,7 @@
                "action":"main"
            }
        ],
-        "result":"Delete objects like users, etc."
+        "result":"Delete a object like context and repository."


Use the same pattern of set description

Fix in 7e0e7ee

sandokandias · 2020-07-27T17:12:05Z

functional/core/core_feature.json

@@ -63,7 +63,7 @@
                "action":"main"
            }
        ],
-        "result":"It can be used to add formulas, repositories and other objects.."
+        "result":"Add a new formula repository to ritchie-cli."


"Add a new repository of formulas"

Fix 7e0e7ee

sandokandias · 2020-07-27T17:13:43Z

pkg/cmd/add.go

-		Long:  descAddLong,
+		Use:     "add SUBCOMMAND",
+		Short:   "Add repositories ",
+		Long:    "Add a new formula repository to ritchie-cli.",


"Add a new repository of formulas"

sandokandias · 2020-07-27T17:15:52Z

pkg/cmd/build.go

-		Short: "This is a root command, needs a sub command",
-		Long:  `This is a root command, to use it, add a sub command. For example, rit build formula.`,
+		Use:     "build SUB_COMMAND",
+		Short:   "Build formulas - with subcomando formulas",


"Build formulas"

Fix in 7e0e7ee

sandokandias · 2020-07-27T17:15:56Z

pkg/cmd/build.go

-		Long:  `This is a root command, to use it, add a sub command. For example, rit build formula.`,
+		Use:     "build SUB_COMMAND",
+		Short:   "Build formulas - with subcomando formulas",
+		Long:    "This is a root command, to use it, add a sub command.",


Use the same pattern of the add description.

Fix in 04b4392

sandokandias · 2020-07-27T17:16:30Z

pkg/cmd/delete.go

-		Short: "Delete objects",
-		Long:  `Delete objects like users, etc.`,
+		Use:     "delete SUBCOMMAND",
+		Short:   "Delete objects (contexts, repositories)",


Use the same pattern of set description

Fix in 7e0e7ee

sandokandias · 2020-07-27T17:16:36Z

pkg/cmd/delete.go

-		Long:  `Delete objects like users, etc.`,
+		Use:     "delete SUBCOMMAND",
+		Short:   "Delete objects (contexts, repositories)",
+		Long:    "Delete a object like context and repository.",


Use the same pattern of set description

Fix in 7e0e7ee

sandokandias · 2020-07-27T17:17:47Z

pkg/cmd/delete_context.go

@@ -31,9 +31,9 @@ func NewDeleteContextCmd(

 	cmd := &cobra.Command{
 		Use:     "context",
-		Short:   "Delete context for Ritchie-cli",
+		Short:   "Delete context for ritchie-cli",


We need to be more clear, ritchie-cli is the program, so maybe you can use delete context for credentials

Right, changed in 7e0e7ee

sandokandias · 2020-07-27T17:19:34Z

pkg/cmd/set.go

-		Short: "Set objects",
-		Long:  `Set objects like credentials, etc.`,
+		Use:     "set SUBCOMMAND",
+		Short:   "Set objects (context, credential, repo-priority)",


"Set contexts, credentials and priorities

Fix 7e0e7ee

Updated help messages for top-level commands

bc5de5e

brunasilvazup changed the title ~~Updated help messages for top-level commands~~ Updated help messages Jul 24, 2020

brunasilvazup assigned brunats Jul 24, 2020

brunasilvazup added 2.0.0 🔨 improvement Improvement in features 🚧 WIP Work in Progress labels Jul 24, 2020

brunats added 11 commits July 24, 2020 17:58

Updated help messages of rit add

1904691

Updated help messages of rit completion

05b17c5

Updated help messages of rit create

58f14e5

Updated help messages of rit delete

f27e191

Updated help messages of rit list

e70558e

Updated help messages of rit set and returned short description of de…

689a7cb

…lete

Updated help messages of rit show

4d81584

Updated help messages of rit update

62bf9a9

Updated help messages of rit build

d55f763

Updated help messages of rit delete context

31b1999

Fix tests

41648a0

brunasilvazup requested review from kaduartur, victor-schumacher and sandokandias July 27, 2020 12:54

sandokandias suggested changes Jul 27, 2020

View reviewed changes

brunats added 2 commits July 27, 2020 14:37

Fix review pt 1

7e0e7ee

Fix review pt 2

04b4392

brunats requested a review from sandokandias July 27, 2020 18:02

sandokandias approved these changes Jul 27, 2020

View reviewed changes

sandokandias merged commit dc33799 into ZupIT:ritchie-2.0.0 Jul 27, 2020

brunats deleted the improvement/information-about-help branch August 26, 2020 20:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated help messages #311

Updated help messages #311

brunats commented Jul 24, 2020 •

edited

Loading

codecov-commenter commented Jul 24, 2020 •

edited

Loading

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

sandokandias Jul 27, 2020

brunats Jul 27, 2020

Updated help messages #311

Updated help messages #311

Conversation

brunats commented Jul 24, 2020 • edited Loading

codecov-commenter commented Jul 24, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brunats commented Jul 24, 2020 •

edited

Loading

codecov-commenter commented Jul 24, 2020 •

edited

Loading