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

More comments and fewer shortcuts in scripts to show process better #1617

Closed
Ace-Dragon opened this issue Apr 3, 2015 · 5 comments
Closed

Comments

@Ace-Dragon
Copy link

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)?

@Ace-Dragon Ace-Dragon changed the title DEMO REQUEST:: More comments in scripts, more lines to show process better DEMOS:: More comments and less shortcuts in scripts to show process better Apr 3, 2015
@Ace-Dragon Ace-Dragon changed the title DEMOS:: More comments and less shortcuts in scripts to show process better DEMOS:: More comments and fewer shortcuts in scripts to show process better Apr 3, 2015
@Wend1go
Copy link

Wend1go commented Apr 7, 2015

I second this.
Best example is the "Navmesh demo". Lots of code for calculating the path with only a single comment.
There should also be a multiline comment at the top of each script that summarises what the code actually does. A license would also be nice.

@akien-mga
Copy link
Member

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.

A license would also be nice.

All of the repo (apart from the external libs) is under the MIT license.

@akien-mga akien-mga changed the title DEMOS:: More comments and fewer shortcuts in scripts to show process better More comments and fewer shortcuts in scripts to show process better Nov 17, 2015
@akien-mga
Copy link
Member

A license would also be nice.

All of the repo (apart from the external libs) is under the MIT license.

I've added an explicit license now btw.

@djrm
Copy link
Contributor

djrm commented Jun 19, 2016

movable to demos repo

@bojidar-bg
Copy link
Contributor

Done.

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

5 participants