minetest_docs
minetest_docs copied to clipboard
Template is overly verbose and at times misleading
trafficstars
- Why all the
{type-<typename>}macros rather than just<typename>? - Why are properties documented as
Vehicle.property? This implies that they were "class variables" (staticin Java) rather than per-instance fields. I suggest documenting them just aspropertyto reduce redundancy. Why do fields not use the table format used for arguments & returns? - "Usage" is redundant with arguments + returns
- Methods shouldn't be referred to as
Vehicle:methodas this may be confused with theclass:newsyntax often used for Lua OOP which MT doesn't use.Vehicleshouldn't be littered all over the document. - Method names should be in
monospace. - Table styling should not be all over the place.
Why all the
{type-<typename>}macros rather than just<typename>?
The type name alone is ambiguous and not explicit. Macros should be prefixed for categorization anyway.
"Usage" is redundant with arguments + returns
Clarity. It is easier to see a line of code than construct it in your head using some tables.
Table styling should not be all over the place.
If it can be global, sure.
[2, 4, 5]
The template is not set in stone yet and still needs iterating. Further discussion should probably be in docs channels.