Parts of API documentation are confusing

[random-geek]

I guess this is a kind of a vague issue, but the API documentation is somewhat confusing to me. I had to dig through the API code to figure out how some things actually work. I have a few suggestions on how it could be made more clear for newcomers, namely the effects/presets sections.

• Firstly, I would suggest adding a section near the top that clearly explains the difference between effects and presets. This is partly explained under register_weather, but it's easy to miss. It should also mention that effects don't do anything without presets to implement them. This is the main thing that confused me.
• Change "associative array" to "table". I understand that "associative array" is a more specific and technical term, but "table" is shorter and is the correct name for the data type in Lua.
• Change "weather effect" to something like "environment effect", or maybe just "effect". With "weather" in the name, it's easy to mix up with the function register_weather.
• Change "weather preset" to "weather type" or "weather". "Preset" is confusing to me, since I think of it as meaning a "default value"; it doesn't seem to go with the intent of the function.

I don't suggest changing any of the function names, just the descriptions.

Sorry if this sounds like complaining, I just wanted to share my thoughts. :-)

[t-affeldt]

Thank you. Those are all very good points. I will update the documentation as soon as I find the time.

[t-affeldt]

Sorry for the very late reply. Thank you for the suggestions!
I have to check whether I have the time to get around to it but I'd be willing to accept push requests as well.