-
-
Notifications
You must be signed in to change notification settings - Fork 18.7k
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
More comments and fewer shortcuts in scripts to show process better #1617
Comments
I second this. |
Adding more comments is probably a good idea. I'm not sure about making a possibility to split all commands as you described above, sometimes it makes sense, but sometimes it's IMO unecessarily detailed.
All of the repo (apart from the external libs) is under the MIT license. |
I've added an explicit license now btw. |
movable to demos repo |
Done. |
The request would especially apply to demos geared toward beginners, the demo files right now make quite a use of multiple functions being done in one line similar to what you can do in python, currently it's something like...
var A = (get_functionA().functionB().functionC())
Possibly, one can make it more understandable for people to make it more readable like doing...
var A = get_functionA()
var B = A.functionB()
var C = B.functionC()
What also confuses newcomers even is that these scripts often have very few comments. There should be a requirement that everything in the demo pack have a decent number of comments in the code that is telling people what the functions are doing, so it would be...
var A = get_functionA() #what it does
var B = A.functionB() #what it does
var C = B.functionC() #what it does
So, in conclusion, would this be a good new convention to adopt for the demos (since they're supposed to be for learning purposes)?
The text was updated successfully, but these errors were encountered: