Skip to content

Commit

Permalink
codegen/go: Remove superfluous newline in doc.go
Browse files Browse the repository at this point in the history
This change fixes the package documentation comment generation that was
broken since #10317.
  • Loading branch information
Frassle committed Nov 30, 2022
1 parent 33c1aa3 commit cac9e26
Show file tree
Hide file tree
Showing 45 changed files with 7 additions and 45 deletions.
@@ -0,0 +1,4 @@
changes:
- type: fix
scope: sdkgen/go
description: Fixes superfluous newline being added between documentation comment and package statement in doc.go
5 changes: 3 additions & 2 deletions pkg/codegen/go/gen.go
Expand Up @@ -838,6 +838,9 @@ func (pkg *pkgContext) toOutputMethod(t schema.Type) string {
return "To" + outputTypeName
}

// printComment filters examples for the Go languages and prepends double forward slash to each line in the given
// comment. If indent is true, each line is indented with tab character. It returns the number of lines in the
// resulting comment. It guarantees that each line is terminated with newline character.
func printComment(w io.Writer, comment string, indent bool) int {
comment = codegen.FilterExamples(comment, "go")

Expand Down Expand Up @@ -1312,7 +1315,6 @@ func (pkg *pkgContext) fieldName(r *schema.Resource, field *schema.Property) str

func (pkg *pkgContext) genPlainType(w io.Writer, name, comment, deprecationMessage string,
properties []*schema.Property) {

printCommentWithDeprecationMessage(w, comment, deprecationMessage, false)
fmt.Fprintf(w, "type %s struct {\n", name)
for _, p := range properties {
Expand Down Expand Up @@ -3602,7 +3604,6 @@ func GeneratePackage(tool string, pkg *schema.Package) (map[string][]byte, error
} else {
fmt.Fprintf(buffer, "// Package %[1]s exports types, functions, subpackages for provisioning %[1]s resources.\n", name)
}
fmt.Fprintf(buffer, "\n")
fmt.Fprintf(buffer, "package %s\n", name)

setFile(path.Join(mod, "doc.go"), buffer.String())
Expand Down
@@ -1,3 +1,2 @@
// A native Pulumi package for creating and managing Azure resources.

package azure
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package foo exports types, functions, subpackages for provisioning foo resources.

package foo
@@ -1,3 +1,2 @@
// Package plantprovider exports types, functions, subpackages for provisioning plantprovider resources.

package plantprovider
@@ -1,3 +1,2 @@
// Package plant exports types, functions, subpackages for provisioning plant resources.

package plant
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package mypkg exports types, functions, subpackages for provisioning mypkg resources.

package mypkg
@@ -1,3 +1,2 @@
// Package repro exports types, functions, subpackages for provisioning repro resources.

package repro
@@ -1,3 +1,2 @@
// Package repro exports types, functions, subpackages for provisioning repro resources.

package repro
@@ -1,3 +1,2 @@
// Package registrygeoreplication exports types, functions, subpackages for provisioning registrygeoreplication resources.

package registrygeoreplication
@@ -1,3 +1,2 @@
// Package repro exports types, functions, subpackages for provisioning repro resources.

package repro
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package foo exports types, functions, subpackages for provisioning foo resources.

package foo
@@ -1,3 +1,2 @@
// Package foo exports types, functions, subpackages for provisioning foo resources.

package foo
@@ -1,3 +1,2 @@
// Package myedgeorder exports types, functions, subpackages for provisioning myedgeorder resources.

package myedgeorder
@@ -1,3 +1,2 @@
// Package mypkg exports types, functions, subpackages for provisioning mypkg resources.

package mypkg
@@ -1,3 +1,2 @@
// Package mypkg exports types, functions, subpackages for provisioning mypkg resources.

package mypkg
@@ -1,3 +1,2 @@
// Package foo exports types, functions, subpackages for provisioning foo resources.

package foo
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package xyz exports types, functions, subpackages for provisioning xyz resources.

package xyz
@@ -1,3 +1,2 @@
// Package configstation exports types, functions, subpackages for provisioning configstation resources.

package configstation
@@ -1,3 +1,2 @@
// Package mongodbatlas exports types, functions, subpackages for provisioning mongodbatlas resources.

package mongodbatlas
@@ -1,3 +1,2 @@
// Package world exports types, functions, subpackages for provisioning world resources.

package world
@@ -1,3 +1,2 @@
// Package my8664 exports types, functions, subpackages for provisioning my8664 resources.

package my8664
@@ -1,3 +1,2 @@
// Package my8110 exports types, functions, subpackages for provisioning my8110 resources.

package my8110
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
1 change: 0 additions & 1 deletion pkg/codegen/testing/test/testdata/secrets/go/mypkg/doc.go
@@ -1,3 +1,2 @@
// Package mypkg exports types, functions, subpackages for provisioning mypkg resources.

package mypkg
@@ -1,3 +1,2 @@
// Package plant exports types, functions, subpackages for provisioning plant resources.

package plant
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package different exports types, functions, subpackages for provisioning different resources.

package different
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example
@@ -1,3 +1,2 @@
// Package example exports types, functions, subpackages for provisioning example resources.

package example

0 comments on commit cac9e26

Please sign in to comment.