Please add descriptions to the hidden tag of new prototypes such as space-locations

[bunshaman]

Some of the new prototypes (such as space-locations, planets, etc) do not have helpful descriptions under their respective pages. In the past, the descriptions would be helpful (see the 3 links), now with no descriptions it becomes unclear what the exact intended behavior is.

For example, the space location prototypes having hidden = true seems to only hide these locations on the space map and in the inventory. However, the location is still visible everywhere else in the game such as in the platform schedules, and the last visited stop/destination under the mini map. Is this a bug? or is this intended behavior? More descriptions would help clear this up

https://lua-api.factorio.com/1.1.110/pr ... tml#hidden
https://lua-api.factorio.com/1.1.110/pr ... tml#hidden
https://lua-api.factorio.com/1.1.110/pr ... tml#hidden

[BraveCaperCat]

Actually, most new prototypes (and new properties for old ones) have unhelpful or absent descriptions.

[Bilka]

For example, the space location prototypes having hidden = true seems to only hide these locations on the space map and in the inventory. However, the location is still visible everywhere else in the game such as in the platform schedules, and the last visited stop/destination under the mini map. Is this a bug? or is this intended behavior? More descriptions would help clear this up

The documentation describes current behaviour, not necessarily intended behaviour. If you want to find out whether something is intended behaviour, make a bug report.

Actually, most new prototypes (and new properties for old ones) have unhelpful or absent descriptions.

Please refer to the following:

Please do not just say "most things in the prototype docs", we know and we'd like to prioritize working what you run into, instead of going alphabetically.

[eugenekay]

The documentation describes current behaviour, not necessarily intended behaviour. If you want to find out whether something is intended behaviour, make a bug report.

This is an interesting angle on documentation ambiguity. It seems like it would be a lot of work for all involved to make a Reproduction case for things that are not broken - just odd or unexpected. I guess it makes sense as “better safe than sorry”. I have run into a few of these myself, but since there was no crash or complaint I just glossed-over it… maybe I should give the docs another full read-through.

[Bilka]

That quote is not about documentation ambiguity. It is about game behaviour. Generally, the documentation follows the game, not the other way around. Writing new documentation will not define whether existing behaviour is a bug. That judgement happens in bug forum, not here.

[Bilka]

All that aside, I've expanded the docs of the hidden property for 2.0.67.