elliotchance / pie

🍕 Enjoy a slice! A utility library for dealing with slices and maps that focuses on type safety and performance.
https://pkg.go.dev/github.com/elliotchance/pie/v2
MIT License
1.96k stars 91 forks source link

Add inline documentation #186

Closed royhadad closed 1 year ago

royhadad commented 1 year ago

When using javascript arrays, we get the following documentation for each method: Screenshot 2023-02-01 at 11 50 09

When using this library, we don't get any docs: Screenshot 2023-02-01 at 11 51 34

Proposed feature: Add short documentation for the methods in the package

elliotchance commented 1 year ago

Yes, you're right. We have docs for all functions, such as: https://github.com/elliotchance/pie/blob/master/v2/map.go

But they need to be copied to the chained versions: https://github.com/elliotchance/pie/blob/master/v2/of.go

Happy to accept a PR for this... 😄