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.

Sign up for GitHub

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

Jump to bottom

GoDoc Compatible Comments #2438

Closed
MrArnoldPalmer opened this issue Jan 20, 2021 · 1 comment
Closed

GoDoc Compatible Comments #2438

MrArnoldPalmer opened this issue Jan 20, 2021 · 1 comment
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. language/go Regarding GoLang bindings p2

Comments

@MrArnoldPalmer
Copy link
Contributor

Verify that all generated go code is correctly formatting documentation strings from source files (jsdoc + TS type information) to be GoDoc compatible. GoDoc converts comment blocks preceding declarations as detailed in this blog post

Doc strings can also be provided for type fields, IE struct and interface fields.

GoDoc Documentation
@MrArnoldPalmer MrArnoldPalmer added feature-request A feature should be added or improved. effort/small Small work item – less than a day of effort p2 labels Jan 20, 2021
@MrArnoldPalmer MrArnoldPalmer mentioned this issue Jan 20, 2021
Closed
4 tasks
@MrArnoldPalmer MrArnoldPalmer added the language/go Regarding GoLang bindings label Mar 30, 2021
Repository owner moved this from Todo to Done in CDK Go General Availability Apr 11, 2022
@github-actions
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. language/go Regarding GoLang bindings p2
Projects
CDK Go General Availability
Status: Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@RomainMuller @MrArnoldPalmer