search

minetest / minetest_docs

Minetest Engine documentation (Work in progress. Meanwhile, please refer to lua_api.txt and dev.minetest.net)
Other
22 stars 13 forks source link

Provide a starting point for terminology #21

Closed appgurueu closed 2 years ago

appgurueu commented 2 years ago

Some terms are used in too many ways, so I started a terminology documentation. Feel free to add terms by editing this PR.

benrob0329 commented 2 years ago

Is this actually all that useful as a general document? It's using terms which Lua modders won't encounter when working with the API (Lua 5.1/JIT doesn't have classes or integers in a user-facing way, just tables/userdata and numbers) and doesn't give good context to their use.

We should aim to use terms which people will actually encounter, rather than those they won't, an explain these terms where they are used. Having some macros for the explanation blurbs might be a better idea.

appgurueu commented 2 years ago

The entire point of this is to explain otherwise ambiguous terms like "integer" (which might be misunderstood as an actual "int" datatype while it's still Lua's "number" datatype in the end), not to repeat Lua(JIT) terminology.

benrob0329 commented 2 years ago

It'd probably be better to have a full article on Data Types then, rather than just a "terminology" doc. I'm willing to help write that, if you want.