Page 1 of 1

Move doc's class description to top of page

Posted: Thu Aug 22, 2019 3:27 pm
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

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

Posted: Mon Aug 26, 2019 11:59 am
by Therenas
I agree with this, it's really easy to overlook in it's current position.

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

Posted: Mon Aug 26, 2019 3:18 pm
by Bilka
Oxyd changed this for the next version:

Image

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

Posted: Tue Aug 27, 2019 1:52 pm
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?

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

Posted: Tue Aug 27, 2019 1:55 pm
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

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

Posted: Thu Aug 29, 2019 1:55 pm
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

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

Posted: Mon Sep 30, 2019 4:27 pm
by Bilka
Changed for the next version:
Image

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

Posted: Mon Sep 30, 2019 7:12 pm
by Therenas
Perfect, I really appreciate this.