Fix function comments based on best practices from Effective Go

hashicorp / yamux

Golang connection multiplexing library

Mozilla Public License 2.0

2.25k stars 236 forks source link

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

Closed CodeLingoBot closed 5 years ago

CodeLingoBot 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.

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

hashicorp-cla commented 5 years ago

All committers have signed the CLA.

Daanikus commented 5 years ago

Hi there! Dan 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.

Dan & the CodeLingo Team