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

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

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

wants to merge 1 commit into from

Conversation

CodeLingoBot
Copy link

Signed-off-by: CodeLingo Bot [email protected]

@mullikine
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.

@mullikine
Copy link

I have triple checked this PR to make sure the bot has done its job of correctly fixing incorrect doc comments without introducing any false positives.

If this service is useful to you, please let me know 😄

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.

@mullikine
Copy link

I noticed that one of the travis-ci tests failed. From a quick read, I think it failed due to "flag provided but not defined: -t".
But if it turns out to be an issue with this PR please let me know so I can touch it up.
Cheers!

@codecov
Copy link

codecov bot commented Feb 27, 2019

Codecov Report

❗ No coverage uploaded for pull request base (develop@2ffb5c6). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop     #115   +/-   ##
==========================================
  Coverage           ?   72.72%           
==========================================
  Files              ?       15           
  Lines              ?      792           
  Branches           ?        0           
==========================================
  Hits               ?      576           
  Misses             ?      128           
  Partials           ?       88
Impacted Files Coverage Δ
node.go 74.25% <ø> (ø)
entity.go 70.88% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2ffb5c6...c97dcb5. Read the comment docs.

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