This looks very weak, feels like even my documentation is more useful. (Currently working on Widget Reference):
https://github.com/Resike/BlizzardIn...ster/Resources
Also i'm not sure whats the point listing the type of arguments/return values and nilability, since it's Lua. It can be table, string or number (or nil) and 99,9% of the time you can tell what it is just by it's name.
Personally i would like to see something like this, and this is what i'm also aiming for:
Lua Code:
GetPlayerMapPosition = { -- Returns the position of a unit on the current map
args = {
unit, -- The unitID for which the position is returned (string)
}
returns = {
x, -- X value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame) (number)
y, -- Y value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame) (number)
}
}
And only add the arg/return types if done with everything.