Skip to content

Commit be99b1d

Browse files
committed
auto-coder: refactor console success message documentation
- Simplify function comments for `Success` and `Successf` to be more concise - Remove redundant implementation details from comments - Shorten example messages in comments Signed-off-by: codiing-hui <wecoding@yeah.net>
1 parent 84b814f commit be99b1d

File tree

1 file changed

+4
-18
lines changed

1 file changed

+4
-18
lines changed

internal/ui/console/success.go

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,14 @@ var successStyle = lipgloss.NewStyle().
1111
PaddingTop(1).
1212
Foreground(lipgloss.Color("2"))
1313

14-
// Success prints styled success message to standard output.
15-
// The message is rendered in bold green text with top padding and automatically
16-
// includes a trailing newline.
17-
//
18-
// Use this for indicating successful operations to users.
19-
//
20-
// Example:
21-
//
22-
// console.Success("Operation completed successfully")
14+
// Success prints a bold green success message with top padding.
15+
// Example: console.Success("Operation completed")
2316
func Success(text string) {
2417
fmt.Println(successStyle.Render(text))
2518
}
2619

27-
// Successf prints a formatted success message to standard output.
28-
// The message is rendered in bold green text with top padding and automatically
29-
// includes a trailing newline. Formatting follows fmt.Printf conventions.
30-
//
31-
// Use this for indicating parameterized successful operations to users.
32-
//
33-
// Example:
34-
//
35-
// console.Successf("Processed %d items successfully", count)
20+
// Successf prints a formatted bold green success message.
21+
// Example: console.Successf("Processed %d items", count)
3622
func Successf(format string, args ...interface{}) {
3723
fmt.Println(successStyle.Render(fmt.Sprintf(format, args...)))
3824
}

0 commit comments

Comments
 (0)