Maintain either wiki or lua-api subdomains, or keep them in sync
Posted: Tue May 05, 2020 12:59 pm
In a recent bug hunt for in my mod's code, I was very surprised to see just how different the lua-api and wiki documentation is in a specific area of interest for me, recipes:
https://lua-api.factorio.com/latest/Lua ... otype.html
https://wiki.factorio.com/Prototype/Recipe
Since I started the mod back in factorio 0.12, I've always assumed that 'latest' in the lua-api subdomain meant 'latest'.
About 80% of my bugs I've needed to fix have been because of other mods using recipe constructs that are 'off specification' according to lua-api. Now I realise that the wiki documentation is more up to date, and my code is what was 'off specification'.
I suggest that:
https://lua-api.factorio.com/latest/Lua ... otype.html
https://wiki.factorio.com/Prototype/Recipe
Since I started the mod back in factorio 0.12, I've always assumed that 'latest' in the lua-api subdomain meant 'latest'.
About 80% of my bugs I've needed to fix have been because of other mods using recipe constructs that are 'off specification' according to lua-api. Now I realise that the wiki documentation is more up to date, and my code is what was 'off specification'.
I suggest that:
- either both these great resources are kept in sync,
- or one is retired,
- or that there are 'health warnings' advising modders to cross reference between the two.