Fix function comments based on best practices from Effective Go

grafov / m3u8

Parser and generator of M3U8-playlists for Apple HLS. Library for Go language. :cinema:

http://tools.ietf.org/html/draft-pantos-http-live-streaming

BSD 3-Clause "New" or "Revised" License

1.23k stars 315 forks source link

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

Open Daanikus opened 5 years ago

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

Daanikus commented 5 years ago

Looks like these changes, few as they are, are pretty solid. Let me know if you find this useful :smile: If not, are there any fixes I can do to make it useful?

Note: I've only updated functions that CodeLingo can rewrite nicely, but you can install it on GitHub to review your PRs automatically and find all issues.

leikao commented 5 years ago

Thank you @Daanikus , it's a good advise, I find there are lot's of golint issues going to be fixed, including the one you mentioned in this PR. It will improve the documents' reading experience after those issues being fixed, would you like to made it better?