Make serpent, log, other library functions searchable in api docs

Place to report issues and suggest improvements to the API documentation.
sparr
Smart Inserter
Smart Inserter
Posts: 1449
Joined: Fri Feb 14, 2014 5:52 pm
Contact:

Make serpent, log, other library functions searchable in api docs

Post by sparr »

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
curiosity
Filter Inserter
Filter Inserter
Posts: 484
Joined: Wed Sep 11, 2019 4:13 pm
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by curiosity »

It won't hurt if type/concept fields were searchable too.
User avatar
Therenas
Factorio Staff
Factorio Staff
Posts: 261
Joined: Tue Dec 11, 2018 2:10 pm
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by Therenas »

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.
curiosity
Filter Inserter
Filter Inserter
Posts: 484
Joined: Wed Sep 11, 2019 4:13 pm
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by curiosity »

Turns out there are inline types. They, too, are unsearchable.
Bilka
Factorio Staff
Factorio Staff
Posts: 3310
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by Bilka »

curiosity wrote: Fri Oct 25, 2024 7:14 am Turns out there are inline types. They, too, are unsearchable.
That's intended because the inline types are not proper types and do not have proper names.
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.
curiosity
Filter Inserter
Filter Inserter
Posts: 484
Joined: Wed Sep 11, 2019 4:13 pm
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by curiosity »

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.
They sure appear to have them.
User avatar
Therenas
Factorio Staff
Factorio Staff
Posts: 261
Joined: Tue Dec 11, 2018 2:10 pm
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by Therenas »

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.
sparr
Smart Inserter
Smart Inserter
Posts: 1449
Joined: Fri Feb 14, 2014 5:52 pm
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by sparr »

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.
curiosity
Filter Inserter
Filter Inserter
Posts: 484
Joined: Wed Sep 11, 2019 4:13 pm
Contact:

Re: Make serpent, log, other library functions searchable in api docs

Post by curiosity »

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.
Except it also stops you from finding the fields of those types.
Post Reply

Return to “Documentation Improvement Requests”