Address comments

hamba · Jun 10, 2024 · 01b716c · 01b716c
1 parent d6a059c
commit 01b716c
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 11 deletions.
diff --git a/cmd/avrogen/testdata/golden.go b/cmd/avrogen/testdata/golden.go
diff --git a/cmd/avrogen/testdata/golden_encoders.go b/cmd/avrogen/testdata/golden_encoders.go
diff --git a/cmd/avrogen/testdata/golden_fullname.go b/cmd/avrogen/testdata/golden_fullname.go
diff --git a/cmd/avrogen/testdata/golden_stricttypes.go b/cmd/avrogen/testdata/golden_stricttypes.go
diff --git a/gen/gen.go b/gen/gen.go
@@ -147,7 +147,7 @@ func WithStrictTypes(b bool) OptsFunc {
 	}
 }
 
-// WithPackageDoc configures the generator to use output the given text as a package doc comment.
+// WithPackageDoc configures the generator to output the given text as a package doc comment.
 func WithPackageDoc(text string) OptsFunc {
 	return func(g *Generator) {
 		g.pkgdoc = text

diff --git a/gen/output_template.tmpl b/gen/output_template.tmpl
@@ -3,7 +3,7 @@
 {{- end }}
 package {{ .PackageName }}
 
-// Code generated by avro/gen. DO NOT EDIT MANUALLY.
+// Code generated by avro/gen. DO NOT EDIT.
 
 {{- $encoders := .WithEncoders }}
 {{ if len .Imports }}
@@ -17,7 +17,9 @@ package {{ .PackageName }}
 {{- range .Typedefs }}
 	{{- if len .Doc }}
 	// {{ .Doc }}
-	{{- end}}	
+	{{- else }}
+	// {{ .Name }} is a generated struct.
+	{{- end }}	
 	type {{ .Name }} struct {
 	{{- range .Fields }}
 		{{- $f := . }}

diff --git a/gen/testdata/golden.go b/gen/testdata/golden.go
diff --git a/gen/testdata/golden_encoders.go b/gen/testdata/golden_encoders.go
diff --git a/gen/testdata/golden_fullname.go b/gen/testdata/golden_fullname.go
diff --git a/gen/testdata/golden_multiple.go b/gen/testdata/golden_multiple.go