search

oleiade / lane

Generic PriorityQueues, Queues, Stacks, and Deque data structures for Go
https://pkg.go.dev/github.com/oleiade/lane#pkg-types
MIT License
878 stars 76 forks source link

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

Closed BlakeMScurr closed 2 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

I know this is a modest little change, still, please let me know if you find it useful :smile:

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

oleiade commented 2 years ago

Hey @BlakeMScurr

Truly sorry I didn't get to this sooner. Three years is a long time 🙏🏻

I've just published v2 of the package which, besides bringing generics support, also made sure that the codebase documented all the functions and types properly.

Closing this, but I sincerely appreciate your contribution nonetheless 🙇🏻

BlakeMScurr commented 2 years ago

No problem, I appreciate you getting back to this anyway!