Make serpent, log, other library functions searchable in api docs
Make serpent, log, other library functions searchable in api docs
The functions on https://lua-api.factorio.com/latest/aux ... aries.html should be searchable keywords in the left sidebar on that page and the rest of the auxiliary pages like https://lua-api.factorio.com/latest/ind ... liary.html
Re: Make serpent, log, other library functions searchable in api docs
It won't hurt if type/concept fields were searchable too.
Re: Make serpent, log, other library functions searchable in api docs
Appreciate the suggestion. I'll put it on the list.
Type fields are already searchable if they are properties, but not if they are unions/tables. We'll discuss whether adding this is worth it.
Type fields are already searchable if they are properties, but not if they are unions/tables. We'll discuss whether adding this is worth it.
Re: Make serpent, log, other library functions searchable in api docs
Turns out there are inline types. They, too, are unsearchable.
Re: Make serpent, log, other library functions searchable in api docs
That's intended because the inline types are not proper types and do not have proper names.curiosity wrote: Fri Oct 25, 2024 7:14 am Turns out there are inline types. They, too, are unsearchable.
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.
Re: Make serpent, log, other library functions searchable in api docs
They sure appear to have them.Bilka wrote: Fri Oct 25, 2024 7:17 am That's intended because the inline types are not proper types and do not have proper names.
Re: Make serpent, log, other library functions searchable in api docs
They have them, but they are never relevant except when using the property that inlines them. So you wouldn't need to search for them separately.
Re: Make serpent, log, other library functions searchable in api docs
You might need to search for them because the FMTK gives you a warning or error that mentions them, or because you see some code that uses them.
Re: Make serpent, log, other library functions searchable in api docs
Except it also stops you from finding the fields of those types.Therenas wrote: Mon Nov 04, 2024 2:05 pm They have them, but they are never relevant except when using the property that inlines them. So you wouldn't need to search for them separately.
Re: Make serpent, log, other library functions searchable in api docs
Okay so for the next release, search will look for more properties. Mainly runtime concept unions, tables and LuaStructs; prototype Type unions; and define 'leaf nodes'. This doesn't satisfy the title of the thread, but I don't think making the lib page show up in search will really do anything. It does satisfy the other stuff this thread brought up.
Also, as a bonus, you can now filter out these property results via a toggle if you just want to search top-level members. All that for the 2.0.67 release ofc.
Also, as a bonus, you can now filter out these property results via a toggle if you just want to search top-level members. All that for the 2.0.67 release ofc.
Re: Make serpent, log, other library functions searchable in api docs
Nice. It's also a first step to a full-text search.
Re: Make serpent, log, other library functions searchable in api docs
Well sort of, it's hard to do that on a static website. We'll see.