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

Code comments in examples? #296

Open
dt-rush opened this issue Dec 4, 2017 · 1 comment
Open

Code comments in examples? #296

dt-rush opened this issue Dec 4, 2017 · 1 comment
Labels
enhancement This issue asks for enhancement in a specific part

Comments

@dt-rush
Copy link

dt-rush commented Dec 4, 2017

It would probably massively improve the value of the examples if they had comments.

I'd be interested in taking on some of this work and could create pull requests to be reviewed.

What motivated me to file this issue is actually a somewhat separate question, though, which I'd also appreciate clarification on while anybody reading is reading:

In the render_goroutines example, I'm not quite sure I understand the use of a mutex lock around running = false, since the mutex is not used anywhere else, so what is it really preventing? I'm writing a project in Go to learn it better so there's probably something I'm missing. Either way code comments could have made the example much richer.

@veeableful
Copy link
Contributor

That's a good idea @dt-rush. The project always needs more improvements so PRs are always welcome and appreciated. Improving the examples is a nice start!

@veeableful veeableful added the enhancement This issue asks for enhancement in a specific part label Jan 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue asks for enhancement in a specific part
Projects
None yet
Development

No branches or pull requests

2 participants