Fix function comments with CodeLingo.

[BlakeMScurr]

Use CodeLingo to automatically fix function comments following the
effective go guidelines mentioned in CONTRIBUTING.md.

This patch was generated by running the CodeLingo Rewrite Flow over the "comment-first-word-as-subject" Tenet.

Note: the same Tenet can be used to automate PR reviews and generate guideline docs.

Install CodeLingo: codelingo.io

[codecov-io]

Codecov Report

Merging #336 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #336   +/-   ##
=======================================
  Coverage   94.43%   94.43%           
=======================================
  Files          13       13           
  Lines        1797     1797           
=======================================
  Hits         1697     1697           
  Misses         97       97           
  Partials        3        3

Impacted Files	Coverage Δ
pkg/commands/git.go	93.37% <ø> (ø)	⬆️
pkg/commands/os.go	83.95% <ø> (ø)	⬆️
pkg/commands/commit.go	0% <ø> (ø)	⬆️

---

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 55712f5...181f91d. Read the comment docs.

[glvr182]

Interesting, I didn't know this tool existed. Is it also able to add comments where non exist?

[BlakeMScurr]

@glvr182 It sure can! In fact I just added that capability codelingo/codelingo#266.

Adding a meaningful comment is really an NLP problem, which is not something that CodeLingo focusses on (yet), but we can append placeholder comments with these few lines:

import codelingo/ast/go

@rewrite --prepend --line "// {{funcName}} is a function."
go.func_decl(depth = any):
  exclude:
    go.comment_group
  go.ident:
    name as funcName
    public == "true"

[BlakeMScurr]

Obviously "// {{funcName}} is a function." is not a massively useful comment, but at least it brings attention to the problem. And you can use CodeLingo to review as well as rewrite - it can comment on your pull requests when you write a function that's missing a comment, then a human can manually write it.

[BlakeMScurr]

Actually I just found out that we’re working on an interactive review command which would come in really handy here. You’ll be able to install our CLI tool and run lingo run rewrite which will prompt you to write your own comment where none exists. Would you guys like to be our alpha testers for it?

[BlakeMScurr]

Discuss post on interactive rewriting

[jesseduffield]

Sounds cool to me, I'm happy to alpha test

[jesseduffield]

thanks for making this PR btw, very cool :)

[BlakeMScurr]

No problem I'm glad you like it! You can get it running automated code reviews on all your PRs by installing our GitHub app https://github.com/apps/codelingo.

The fun part is definitely writing your own custom tenets (linter/rewrite rules) though - so feel free to hop in our slack :)

[BlakeMScurr]

By the way, it'd be great to get a tweet if you're up for it. Something like "@codelingoapp just fixed my bugs!" Thank you!