Skip to content

Commit

Permalink
Update aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Jul 13, 2023
1 parent 5afa891 commit db1c3cf
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
9 changes: 5 additions & 4 deletions app/client/cli/debug.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ func newDebugUISubCommands() []*cobra.Command {
// newDebugUICommand returns the cobra CLI for the Debug UI interface.
func newDebugUICommand() *cobra.Command {
return &cobra.Command{
Aliases: []string{"dui", "d"},
Use: "debugui",
Aliases: []string{"dui"},
Use: "DebugUI",
Short: "Debug selection ui for rapid development",
Args: cobra.MaximumNArgs(0),
PersistentPreRunE: helpers.P2PDependenciesPreRunE,
Expand All @@ -84,7 +84,8 @@ func newDebugUICommand() *cobra.Command {
// newDebugCommand returns the cobra CLI for the Debug command.
func newDebugCommand() *cobra.Command {
return &cobra.Command{
Use: "debug",
Use: "Debug",
Aliases: []string{"d"},
Short: "Debug utility for rapid development",
Args: cobra.MaximumNArgs(1),
PersistentPreRunE: helpers.P2PDependenciesPreRunE,
Expand All @@ -95,9 +96,9 @@ func debugCommands() []*cobra.Command {
cmds := []*cobra.Command{
{
Use: "TriggerView",
Aliases: []string{"next", "trigger", "view"},
Short: "Trigger the next view in consensus",
Long: "Sends a message to all visible nodes on the network to start the next view (height/step/round) in consensus",
Aliases: []string{"triggerView"},
Args: cobra.ExactArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
m := &messaging.DebugMessage{
Expand Down
3 changes: 3 additions & 0 deletions app/client/cli/docgen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import (
"github.com/spf13/cobra/doc"
)

// TODO: Document that `Aliases` should be either dromedaryCase, one word lowercase, or just a few lowercase letters.
// TODO: Document that `Use` should also be PascalCase

func main() {
workingDir, err := os.Getwd()
if err != nil {
Expand Down

0 comments on commit db1c3cf

Please sign in to comment.