search

papertrail / remote_syslog2

To install, see "Releases" tab. Self-contained daemon for reading local files and emitting remote syslog (without using local syslogd).
http://help.papertrailapp.com/
MIT License
637 stars 157 forks source link

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

Closed BlakeMScurr closed 5 years ago

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

BlakeMScurr commented 5 years ago

It looks like there are fix ups that update the tense and read well, namely this, and this.

However, other changes like basically just add colons to conform to the standard and arguably make comments less readable.

Let me know if you think this is valuable! :smile:

BlakeMScurr commented 5 years ago

Let me know what I can do to fix Travis too, by the way! Looks like the build in the syslog tests somehow failed, but I don't see how I could have done that :thinking:

BlakeMScurr commented 5 years ago

outdated