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

Add comment-marker for generated reference-type comment lines #87

Merged
merged 2 commits into from
Aug 29, 2022

Conversation

ulucinar
Copy link
Collaborator

@ulucinar ulucinar commented Aug 29, 2022

Description of your changes

Looks like we are currently generating reference-type comment lines without the comment marker, i.e., //.

I have:

  • Read and followed Crossplane's contribution process.
  • Run make reviewable to ensure this PR is ready for review.
  • Added backport release-x.y labels to auto-backport this PR if necessary.

How has this code been tested

Running the code-gen pipeline with provider-{aws,azure,gcp}.

friendlyTypeDescription(f.Reference.Type), f.Name.LowerCamelComputed, commentOptional.Build())
selComment = fmt.Sprintf("Selector for a list of %s to populate %s.\n%s",
selComment = fmt.Sprintf("// Selector for a list of %s to populate %s.\n%s",
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for catching this! I think you need to fix the tests as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

Signed-off-by: Alper Rifat Ulucinar <[email protected]>
@ulucinar ulucinar merged commit d27f576 into crossplane:main Aug 29, 2022
@ulucinar ulucinar deleted the fix-ref-gen branch August 29, 2022 15:58
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.

2 participants