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.

Sign up for GitHub

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

Jump to bottom

Examples need better explanation #53

Open
JohnTheCoolingFan opened this issue May 9, 2023 · 1 comment
Open

Examples need better explanation #53

JohnTheCoolingFan opened this issue May 9, 2023 · 1 comment

Comments

@JohnTheCoolingFan
Copy link
Contributor

I'm reading examples to understand how exactly can I use this crate for my project. So far it wasn't very easy to understand, I had to go back and forth: exampels, script assets, API docs. And also I don't understand some comments completely, like this one. It looks like it's out of place.

This is why I think exampels need improvements to the explanation comments and more such comments.
@makspll
Copy link
Owner

makspll commented May 12, 2023

I completely agree, the examples started out relatively sane but the library underwent some significant changes since its conception so some comments went astray

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@makspll @JohnTheCoolingFan