Reorder comments docs in readme diff --git a/README.md b/README.md index 4627074..584560a 100644 --- a/README.md +++ b/README.md @@ -891,13 +891,13 @@ fmt.Printf("%#v", f) ``` ### Comments +PackageComment adds a comment to the top of the file, above the package +keyword. + HeaderComment adds a comment to the top of the file, above any package comments. A blank line is rendered below the header comments, ensuring header comments are not included in the package doc. -PackageComment adds a comment to the top of the file, above the package -keyword. - ```go f := NewFile("c") f.HeaderComment("Code generated by...") diff --git a/README.md.tpl b/README.md.tpl index c4fd61f..f51af6a 100644 --- a/README.md.tpl +++ b/README.md.tpl @@ -384,10 +384,10 @@ avoid this, use Clone. {{ "Statement.Clone" | doc }} {{ "ExampleFile_Anon" | example }} ### Comments -{{ "File.HeaderComment" | doc }} - {{ "File.PackageComment" | doc }} +{{ "File.HeaderComment" | doc }} + {{ "ExampleFile_HeaderAndPackageComments" | example }}