better document, not just changelog & source
Posted: 05 Jan 2011, 18:37
Not really a feature request but a appeal to better document (new) features. Without docu, how should the new features be used?
Changelog or engine source is not a docu imo.
Some things can be figured out but other things are impossible to know. I think compared to adding something to the engine, a quick note should not be so much trouble?
Mostly Lua, ie
http://springrts.com/wiki/LuaCallinReturn
and other lists, are they complete?
LayoutButtons() --> unknown, please document.
CommandsChanged() --> unknown (none?)
AllowFeatureBuildStep() --> unknown, please document.
Another thing that could need more docu is MoveCtrl, I think not all callins/outs are listed ie MoveCtrlNotify seems to be missing and what does it do? (just example)
Also UnitDefs and Weapons
Some tags are easy to figure out (maxDamage) while for others it is hard to see what they do or what are valid ranges and how they influence each other.
Changelog or engine source is not a docu imo.
Some things can be figured out but other things are impossible to know. I think compared to adding something to the engine, a quick note should not be so much trouble?
Mostly Lua, ie
http://springrts.com/wiki/LuaCallinReturn
and other lists, are they complete?
LayoutButtons() --> unknown, please document.
CommandsChanged() --> unknown (none?)
AllowFeatureBuildStep() --> unknown, please document.
Another thing that could need more docu is MoveCtrl, I think not all callins/outs are listed ie MoveCtrlNotify seems to be missing and what does it do? (just example)
Also UnitDefs and Weapons
Some tags are easy to figure out (maxDamage) while for others it is hard to see what they do or what are valid ranges and how they influence each other.