Indent examples in line with other help sections (#112)

* Indent examples in line with other help sections * Redo demos
FollowTheProcess · Oct 25, 2024 · 82da24d · 82da24d
1 parent 777dd91
commit 82da24d
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -4,6 +4,7 @@ version: "3"
 
 vars:
   COV_DATA: coverage.out
+  PACKAGE: github.com/FollowTheProcess/cli
 
 tasks:
   default:

diff --git a/command.go b/command.go
@@ -185,7 +185,7 @@ type example struct {
 
 // String implements [fmt.Stringer] for [Example].
 func (e example) String() string {
-	return fmt.Sprintf("\n# %s\n$ %s\n", e.comment, e.command)
+	return fmt.Sprintf("\n  # %s\n  $ %s\n", e.comment, e.command)
 }
 
 // Execute parses the flags and arguments, and invokes the Command's Run

diff --git a/docs/img/quickstart.gif b/docs/img/quickstart.gif
diff --git a/testdata/TestHelp/with-examples.txt b/testdata/TestHelp/with-examples.txt
@@ -3,11 +3,11 @@ A placeholder for something cool
 Usage: test [OPTIONS] ARGS...
 
 Examples:
-# Do a thing
-$ test do thing --now
+  # Do a thing
+  $ test do thing --now
 
-# Do a different thing
-$ test do thing --different
+  # Do a different thing
+  $ test do thing --different
 
 Options:
   -h  --help     bool  Show help for test [default false]
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ version: "3" @@
     vars:
       COV_DATA: coverage.out
+      PACKAGE: github.com/FollowTheProcess/cli
     tasks:
       default:
@@ Expand Down @@