chore: Minor documentation change

armsnyder · Jul 1, 2024 · 3bffc0f · 3bffc0f
1 parent be377fc
commit 3bffc0f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 9 deletions.
diff --git a/ts2go.go b/ts2go.go
@@ -52,7 +52,7 @@ type Struct struct {
 	CustomData CustomData
 }
 
-// Field is the data model for the field.tmpl template.
+// Field is the data model for a field within a struct.
 type Field struct {
 	Name       string
 	Doc        []string

diff --git a/ts2go_example_test.go b/ts2go_example_test.go
@@ -10,10 +10,11 @@ import (
 
 func Example() {
 	source := strings.NewReader(`
-/**
- * My type
- */
-type Foo = { bar?: string /* My field */ }`)
+		/**
+		 * My type
+		 */
+		type Foo = { bar?: string /* My field */ }`,
+	)
 
 	output := &bytes.Buffer{}
 
@@ -38,10 +39,11 @@ type Foo = { bar?: string /* My field */ }`)
 
 func Example_mixins() {
 	source := strings.NewReader(`
-/**
- * My type
- */
-type Foo = { bar?: string /* My field */ }`)
+		/**
+		 * My type
+		 */
+		type Foo = { bar?: string /* My field */ }`,
+	)
 
 	output := &bytes.Buffer{}