Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

codegen/go: Remove superfluous newline in doc.go #11331

Closed
wants to merge 1 commit into from
Closed

Conversation

tie
Copy link

@tie tie commented Nov 11, 2022

Description

This change fixes the package documentation comment generation that was broken since #10317.

That is, Go requires package documentation comment to be strictly before the package statement without newlines in-between.

Good

// Package good has documentation comment.
package bad

Bad

// Package bad does no have a documentation comment.

package bad

Checklist

  • I have added tests that prove my fix is effective or that my feature works
  • I have run make changelog and committed the changelog/pending/<file> documenting my change
  • Yes, there are changes in this PR that warrants bumping the Pulumi Service API version

This change fixes the package documentation comment generation that was
broken since pulumi#10317.
@pulumi-bot
Copy link
Contributor

Changelog

[uncommitted] (2022-11-11)

Bug Fixes

  • [sdkgen/go] Fixes superfluous newline being added between documentation comment and package statement in doc.go

Copy link
Member

@Frassle Frassle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks

@Frassle
Copy link
Member

Frassle commented Nov 11, 2022

bors merge

@bors
Copy link
Contributor

bors bot commented Nov 11, 2022

🕐 Waiting for PR status (GitHub check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set.

@dixler
Copy link
Contributor

dixler commented Nov 21, 2022

/run-acceptance-tests
Please view the results of the acceptance tests Here

@jazzyfresh
Copy link
Contributor

going to try a bors merge because the acceptance tests are all green. the CI test failures above were from "No github token found", which is likely because this is a community pull request from outside the pulumi org.

@jazzyfresh
Copy link
Contributor

bors merge

@bors
Copy link
Contributor

bors bot commented Nov 22, 2022

🕐 Waiting for PR status (GitHub check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set.

@Frassle
Copy link
Member

Frassle commented Nov 30, 2022

Thanks for this change, unfortunately our CI is having issues with community contributions at the moment but I did manage to convince it to accept the change in another PR: #11492

@Frassle Frassle closed this Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants