Skip to content
This repository was archived by the owner on Sep 22, 2020. It is now read-only.

Fix function comments based on best practices from Effective Go#253

Open
Daanikus wants to merge 1 commit intocoreos:masterfrom
CodeLingoBot:rewrite
Open

Fix function comments based on best practices from Effective Go#253
Daanikus wants to merge 1 commit intocoreos:masterfrom
CodeLingoBot:rewrite

Conversation

@Daanikus
Copy link

Every exported function in a program should have a doc comment. The first sentence should be a summary that starts with the name being declared.
From effective go.

I generated this with CodeLingo and I'm keen to get some feedback, but this is automated so feel free to close it and just say "opt out" to opt out of future CodeLingo outreach PRs.

Signed-off-by: CodeLingo Bot <bot@codelingo.io>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments