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

Does the documentation for Decoder.KnownFields make grammatical sense? #1042

Open
ardnew opened this issue Aug 7, 2024 · 0 comments
Open

Comments

@ardnew
Copy link

ardnew commented Aug 7, 2024

KnownFields ensures that the keys in decoded mappings to exist as fields in the struct being decoded into.

I can't tell if there is a typo somewhere, missing punctuation, or some sort of pun or word puzzle I'm too dense to detect — but, as documentation, this reads as broken English.

There is an open PR #898 to address this. And since I was looking up the documentation to understand what the method does, I can't make much sense of that one either.

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

1 participant