Skip to content

Commit e00dfd4

Browse files
committed
docs: add docstrings to env CLI command builder functions
Resolves CodeRabbit docstring coverage warning on PR #127. All six functions in cli/env.go now have Go doc comments, bringing coverage from ~17% to 100% for that file. https://claude.ai/code/session_01E2yrXXhJW7Jt7ZPt7JYMWF
1 parent 767999a commit e00dfd4

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

  • packages/engine/internal/cli

packages/engine/internal/cli/env.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"github.com/spf13/cobra"
1313
)
1414

15+
// newEnvCommand returns the "env" subcommand for managing named environments.
1516
func newEnvCommand() *cobra.Command {
1617
cmd := &cobra.Command{
1718
Use: "env",
@@ -27,6 +28,8 @@ func newEnvCommand() *cobra.Command {
2728
return cmd
2829
}
2930

31+
// newEnvCreateCommand returns the "env create" subcommand, which stores a new
32+
// named environment loaded from a values file.
3033
func newEnvCreateCommand() *cobra.Command {
3134
var fromFile string
3235

@@ -67,6 +70,8 @@ func newEnvCreateCommand() *cobra.Command {
6770
return cmd
6871
}
6972

73+
// newEnvListCommand returns the "env list" subcommand, which prints all named
74+
// environments for the current team.
7075
func newEnvListCommand() *cobra.Command {
7176
return &cobra.Command{
7277
Use: "list",
@@ -98,6 +103,8 @@ func newEnvListCommand() *cobra.Command {
98103
}
99104
}
100105

106+
// newEnvShowCommand returns the "env show" subcommand, which prints the inputs
107+
// and env vars stored in a named environment.
101108
func newEnvShowCommand() *cobra.Command {
102109
return &cobra.Command{
103110
Use: "show <name>",
@@ -143,6 +150,8 @@ func newEnvShowCommand() *cobra.Command {
143150
}
144151
}
145152

153+
// newEnvDeleteCommand returns the "env delete" subcommand, which removes a
154+
// named environment from the database.
146155
func newEnvDeleteCommand() *cobra.Command {
147156
return &cobra.Command{
148157
Use: "delete <name>",

0 commit comments

Comments
 (0)