Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usability of DecodeHookFunc* types #21

Open
DerGut opened this issue May 16, 2024 · 1 comment
Open

Usability of DecodeHookFunc* types #21

DerGut opened this issue May 16, 2024 · 1 comment

Comments

@DerGut
Copy link

DerGut commented May 16, 2024

Hi 👋
Thanks for taking over the project!

I've noticed in the past (and today I'm noticing again), that it's not immediately obvious to me how to use the DecodeHookFunc* family of types/ funcs. Both times, I ended up diving into the code to understand how they work from reading the tests and implementations of StringTo{stdLibType}HookFuncs.
The code is very easy to read, so this wasn't exactly a bad experience 😄 But: I'd still expect the GoDoc to contain all the info I need to use them correctly.

IMO they could really use an example and/ or a section in the package overview. Therefore, I suggest to

Would anybody object if I created a PR to do this?

@sagikazarmark
Copy link
Member

Hey @DerGut !

A PR would be greatly appreciated! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants