Page 1 of 1

Wiki documentation comment/tag ?

Posted: Fri Apr 29, 2011 9:39 am
by TsT
Hello,

It could be interesting to show in each love function page if the function are useful for what kind of use :
- basic (a beginner must be learn it)
- advanced (you should learn)
- expert (you probably don't need it)
- internal (just for information)

What is your opinion ?

Regards,

Re: Wiki documentation comment/tag ?

Posted: Fri Apr 29, 2011 10:14 am
by Lafolie
I don't think that it's necessary. No one function is more or less important than another. It depends on the context that they're used in and what the desired effect is.

Re: Wiki documentation comment/tag ?

Posted: Fri Apr 29, 2011 10:52 am
by TsT
Lafolie wrote:I don't think that it's necessary. No one function is more or less important than another. It depends on the context that they're used in and what the desired effect is.
I'm not agree, some functions are always more often use than others.
Just compare love.filesystem.load and love.event.pump !
I think about beginners who see so many functions...

Maybe the solution is making a tutorial that list the most usual functions to know for beginners.

Re: Wiki documentation comment/tag ?

Posted: Fri Apr 29, 2011 11:31 am
by Lafolie
But that's what a tutorial is for, yeah. Giving a function the connotation of being intended for a beginner or 'advanced user' (whatever that means) doesn't really achieve anything. If anything, it's going to scare off beginners from using a particular set of functions which could in turn lead to bad working practices.

I don't see any benefit in labelling a particular function as 'for beginners'. Because they're not. They're just functions. Some things are easier to understand than others, like say... I can see how framebuffers might confuse someone new to programming... but still, framebuffers weren't made with some kinda 'super user' in mind. It was made with a purpose.

Re: Wiki documentation comment/tag ?

Posted: Fri Apr 29, 2011 12:41 pm
by Robin
Lafolie wrote:It was made with a purpose.
This.

If anything, we need more elaborate tutorials, introducing new lovers to more advanced concepts and use cases. Damn, I should really kick start LÖVECHILD sometime.