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

Comments for all types and ensure comments are generated too #1489

Closed
matt2e opened this issue May 15, 2024 · 0 comments
Closed

Comments for all types and ensure comments are generated too #1489

matt2e opened this issue May 15, 2024 · 0 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@matt2e
Copy link
Collaborator

matt2e commented May 15, 2024

We have our template to generate the file here: go-runtime/compile/external-module-template/_ftl/go/modules/{{ range .NonMainModules }}{{ push .Name . }}{{ end }}/external_module.go

For verbs, we include comments like this:

{{- else if is "Verb" . -}}
{{.Comments|comment }}
{{if .Comments}}//
{{end -}}
//ftl:verb

We do not do this for any other declaration (enum & typealias)

@matt2e matt2e added the good first issue Good for newcomers label May 15, 2024
@github-actions github-actions bot added the triage Issue needs triaging label May 15, 2024
@gak gak self-assigned this May 15, 2024
@github-actions github-actions bot removed the triage Issue needs triaging label May 15, 2024
@gak gak changed the title scaffolded external_module.go files don't have comments included for anything other than verbs Comments for all types and ensure comments are generated too May 16, 2024
@gak gak closed this as completed May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants