journey icon indicating copy to clipboard operation
journey copied to clipboard

Fix function comments based on best practices from Effective Go

Open CodeLingoBot opened this issue 5 years ago • 2 comments

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.

PR generated by CodeLingo. Install here to drive Continuous Higher Standards.

CodeLingoBot avatar Feb 13 '19 01:02 CodeLingoBot

Hi there!

@BlakeMScurr from CodeLingo here. This PR is testing out a new service. I'd love to hear your feedback or answer your questions. We're keen to learn how we can best help dev teams without getting in your way.

@BlakeMScurr & the CodeLingo Team

BlakeMScurr avatar Feb 13 '19 03:02 BlakeMScurr

@kabukky how valuable do you find these changes? You should pass golint now - is that worth much to you? Would it be a significant improvement if we rewrote the first comment to Ghost converts a Ghost database to use with Journey rather than Ghost: Function to convert a Ghost database to use with Journey?

BlakeMScurr avatar Feb 13 '19 03:02 BlakeMScurr