ParameterGroup description should be listed as optional

Place to report issues and suggest improvements to the API documentation.
Post Reply
User avatar
SpeckledFleebeedoo
Burner Inserter
Burner Inserter
Posts: 16
Joined: Thu Nov 26, 2020 3:44 pm
Contact:

ParameterGroup description should be listed as optional

Post by SpeckledFleebeedoo »

The description field for a ParameterGroup in the runtime docs json API is not listed as optional but is not present for a number of them, so it should probably be listed as optional. The first example I ran into was on LuaControl::set_gui_arrow.

Alternatively, for consistency, it may be better if these are given descriptions in the API, as currently the ParameterGroups are the only types in the API that may lack descriptions.
Locomotive aficionado. Also known as Train Tech

Post Reply

Return to “Documentation Improvement Requests”