Skip to content
This repository was archived by the owner on Aug 12, 2022. It is now read-only.

Commit 084fea2

Browse files
authored
Description improvement (#55)
1 parent 6b661df commit 084fea2

File tree

7 files changed

+22
-15
lines changed

7 files changed

+22
-15
lines changed

docs/cmd/ach.md

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/cmd/ach_contest.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/cmd/ach_contest_create.md

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/cmd/ach_version.md

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

internal/cmd/ach/ach.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ import (
66
"github.com/yuchiki/atcoderHelper/internal/cmd/ach/version"
77
)
88

9+
// NewAchCmd returns ach command.
910
func NewAchCmd() *cobra.Command {
1011
cmd := &cobra.Command{
1112
Use: "ach",
12-
Short: "ach は Atcoder出場に際する定形作業を自動化します",
13-
Long: `ach は Atcoder出場に際する定形作業を自動化します。`,
13+
Short: "ach automates routine work you does when you participate AtCoder contests",
14+
Long: `ach automates routine work you does when you participate AtCoder contests. `,
1415
}
1516

1617
registerSubcommands(cmd)

internal/cmd/ach/contest/create/create.go

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,11 @@ func NewContestCreateCmd() *cobra.Command {
2020
cmd := &cobra.Command{
2121
Use: "create [contestName]",
2222
Short: "creates contest directory",
23-
Long: "creates contest directory.",
24-
Args: cobra.ExactArgs(1),
23+
Long: `creates contest directory.
24+
Temporally, current template directory is hard-coded as $HOME/projects/private/atcoder/D
25+
D is for directory.
26+
`,
27+
Args: cobra.ExactArgs(1),
2528
RunE: func(cmd *cobra.Command, args []string) error {
2629
contestName := args[0]
2730
err := exec.Command("mkdir", contestName).Run()
@@ -42,7 +45,7 @@ func NewContestCreateCmd() *cobra.Command {
4245
},
4346
}
4447

45-
cmd.Flags().BoolVarP(useDefaultTemplate, "default-template", "d", false, "use default contest template")
48+
cmd.Flags().BoolVarP(useDefaultTemplate, "default-template", "d", false, "(required) use default contest template")
4649

4750
if cmd.MarkFlagRequired("default-template") != nil {
4851
log.Fatal("default-template require")

internal/cmd/ach/version/version.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ var (
2424
func NewVersionCmd() *cobra.Command {
2525
return &cobra.Command{
2626
Use: "version",
27-
Short: "show version",
28-
Long: "show version.",
27+
Short: "shows version",
28+
Long: "shows version.",
2929
RunE: func(cmd *cobra.Command, args []string) error {
3030
Build := Version{
3131
Version: version,

0 commit comments

Comments
 (0)