Wiki documentation comment/tag ?

General discussion about LÖVE, Lua, game development, puns, and unicorns.
Post Reply
User avatar
TsT
Party member
Posts: 161
Joined: Thu Sep 25, 2008 7:04 pm
Location: France
Contact:

Wiki documentation comment/tag ?

Post by TsT » Fri Apr 29, 2011 9:39 am

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,
My projects current projects : dragoon-framework (includes lua-newmodule, lua-provide, lovemodular, , classcommons2, and more ...)

User avatar
Lafolie
Inner party member
Posts: 804
Joined: Tue Apr 05, 2011 2:59 pm
Location: SR388
Contact:

Re: Wiki documentation comment/tag ?

Post by Lafolie » Fri Apr 29, 2011 10:14 am

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.
Do you recognise when the world won't stop for you? Or when the days don't care what you've got to do? When the weight's too tough to lift up, what do you? Don't let them choose for you, that's on you.

User avatar
TsT
Party member
Posts: 161
Joined: Thu Sep 25, 2008 7:04 pm
Location: France
Contact:

Re: Wiki documentation comment/tag ?

Post by TsT » Fri Apr 29, 2011 10:52 am

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.
My projects current projects : dragoon-framework (includes lua-newmodule, lua-provide, lovemodular, , classcommons2, and more ...)

User avatar
Lafolie
Inner party member
Posts: 804
Joined: Tue Apr 05, 2011 2:59 pm
Location: SR388
Contact:

Re: Wiki documentation comment/tag ?

Post by Lafolie » Fri Apr 29, 2011 11:31 am

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.
Do you recognise when the world won't stop for you? Or when the days don't care what you've got to do? When the weight's too tough to lift up, what do you? Don't let them choose for you, that's on you.

User avatar
Robin
The Omniscient
Posts: 6506
Joined: Fri Feb 20, 2009 4:29 pm
Location: The Netherlands
Contact:

Re: Wiki documentation comment/tag ?

Post by Robin » Fri Apr 29, 2011 12:41 pm

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.
Help us help you: attach a .love.

Post Reply

Who is online

Users browsing this forum: No registered users and 5 guests