search

remogatto / mandala

A Go framework for writing native Android applications
MIT License
620 stars 50 forks source link

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

Open CodeLingoBot opened 5 years ago

CodeLingoBot commented 5 years ago

Signed-off-by: CodeLingo Bot bot@codelingo.io

mullikine commented 5 years ago

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.

mullikine commented 5 years ago

I have looked over each of the changes made by the bot, and it appears to have done the right thing in each situation, fixing the incorrect doc comments. A side effect of the current algorithm is that the parentheses were removed from ResourceManager() and Events() to make the sentence flow, as it was used to begin the doc comment. If this doesn't seem right to you, please let me know so I can remove that logic for future users.

I hope this was useful to you. Your feedback is valuable to us.

Note: I've only updated functions that I know CodeLingo can rewrite nicely, but you can install it from the GitHub marketplace to review your PRs automatically and find all issues.