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

Fixed misleading binding in usage example snippet #24

Merged
merged 7 commits into from
Aug 23, 2023
Merged

Conversation

Hejtmus
Copy link
Contributor

@Hejtmus Hejtmus commented Aug 23, 2023

Hello @janosh,

great library. Yesterday when I discovered it, I wanted it to test it before using, and I discovered small inconvenience. Example code has incorrect binding in it, which is perfectly fine, but not if you are experimenting with a lot of libs in bulk, and you just want to see whether reference implementation of some lib works within your project. Obviously, when you are choosing library, you read it's source code, but I personally like to blind test it, and then later dig through docs and source. When I blind copied reference implementation, it didn't work, and I had to debug it, to find out that reference implementation is actually pseudocode. So I think that this little change could save some devs time :).

Best regards,
Filip.

Copy link
Owner

@janosh janosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, doc improvements are always appreciated! Needed to do some housekeeping anyway.

@janosh janosh added documentation Improvements or additions to documentation housekeeping Housekeeping labels Aug 23, 2023
@janosh janosh merged commit 34b232e into janosh:main Aug 23, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation housekeeping Housekeeping
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants