Move doc's class description to top of page

Post Reply
Boodals
Fast Inserter
Fast Inserter
Posts: 129
Joined: Sun Feb 11, 2018 7:10 pm
Contact:

Move doc's class description to top of page

Post by Boodals »

Lots of new modders don't see the class descriptions. It doesn't matter too much for most classes, but for things like LuaItemStack it's quite important to read. It should really be at the very top of the page, so that you see it immediately. At the moment its under the summary of functions/variables, which is really arbitrary and hidden.
For clarification, I mean this part: Image
I'd do it myself with source access, but i'm not comfortable with python (which is used to generate the docs).
thx

User avatar
Therenas
Factorio Staff
Factorio Staff
Posts: 232
Joined: Tue Dec 11, 2018 2:10 pm
Contact:

Re: Move doc's class description to top of page

Post by Therenas »

I agree with this, it's really easy to overlook in it's current position.

Bilka
Factorio Staff
Factorio Staff
Posts: 3132
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: Move doc's class description to top of page

Post by Bilka »

Oxyd changed this for the next version:

Image
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.

Boodals
Fast Inserter
Fast Inserter
Posts: 129
Joined: Sun Feb 11, 2018 7:10 pm
Contact:

Re: Move doc's class description to top of page

Post by Boodals »

I don't like that its below the "class LuaItemStack - sort" text. Can that get changed real quick or should I make another interface request?

Bilka
Factorio Staff
Factorio Staff
Posts: 3132
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: Move doc's class description to top of page

Post by Bilka »

I had the same initial reaction, however moving it above that would cause problems on pages with multiple classes, such as the concepts page. To illustrate, the description would above the class, so the gameviewsettings description would be where the green line is in this case:
Image
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.

Boodals
Fast Inserter
Fast Inserter
Posts: 129
Joined: Sun Feb 11, 2018 7:10 pm
Contact:

Re: Move doc's class description to top of page

Post by Boodals »

I think it would be better to have the description above the "sort" button on the class pages, and keep the concepts page as it is now. You can still read the description of the concepts if you click on the link to the concept.
Image

Bilka
Factorio Staff
Factorio Staff
Posts: 3132
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: Move doc's class description to top of page

Post by Bilka »

Changed for the next version:
Image
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.

User avatar
Therenas
Factorio Staff
Factorio Staff
Posts: 232
Joined: Tue Dec 11, 2018 2:10 pm
Contact:

Re: Move doc's class description to top of page

Post by Therenas »

Perfect, I really appreciate this.

Post Reply

Return to “Implemented mod requests”