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

Comments in the Code #14

Open
wpmark opened this issue Jan 18, 2018 · 0 comments
Open

Comments in the Code #14

wpmark opened this issue Jan 18, 2018 · 0 comments

Comments

@wpmark
Copy link

wpmark commented Jan 18, 2018

Firstly thanks so much for sharing these examples. They have provided a good starting point for me, a PHP WordPress developer having to start learning how to use javascript in order to keep up with WordPress.

One thing that I would love to see is more comments in the code please. I probably over comment my code, but to someone coming along and reading this as a new language it would make much more sense if comments we added to code lines or at the very least blocks, to indicate to devs like me what actually is going on.

For example take this line of code:

https://github.com/WordPress/gutenberg-examples/blob/master/03-editable/block.js#L29

It would be super useful to have a 1 or 2 line comment explaining what is happening with that part of the code. Thanks in advance.

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

No branches or pull requests

2 participants