Rubidium wrote:

In my opinion the whole bottom 60% of the description does not even belong there. It's something that should tell the user why he would want it, not a description of how the code is structured.

Even then, you can't add lots and lots of text. It's limited to 500 characters and I bet he is right at the limit with that massive listing.

Just like the NewGRF description there is a certain minimum amount of text that will be shown. Anything else is just extra information that might not make it if the window is made too small.

This comment was imported from FlySpray: https://bugs.openttd.org/task/5022#comment10831

Moriarty wrote:

If the limit is 500 characters I'd posit that the game should be able to display 500 characters clearly and obviously. Its irrelevent whether the NewGRF maker has filled the description with a Illyiad like Epic or something actually pertinent, only that OTTD displays it properly.

This comment was imported from FlySpray: https://bugs.openttd.org/task/5022#comment10867

Zuu wrote:

A user should never want a library. Thus, the description of a library can be targeted to potential AI developers who might be interested in what domains that the library supply functions.

That is the reason why it contains this information.

This comment was imported from FlySpray: https://bugs.openttd.org/task/5022#comment10897

Alberth wrote:

Unless you add the entire text of all functions in full detail, that information is useless to a developer. He still has to consult the developer documentation where you have to repeat this information any way.

I think your idea of addressing a developer is right, but you are using the wrong abstraction level. Imho you should aim for a more global description, like

This library supports AI programs by providing functions for common tasks, such as infra structure building, setting up orders for vehicles, and managing the finances.

This comment was imported from FlySpray: https://bugs.openttd.org/task/5022#comment10909

Zuu wrote:

I've now updated the SuperLib description for version 19 to use a summarized description of what the library can do rather than listing all classes.

It the beginning the list of classes was just three, so it has been growing longer and longer. :-)

This comment was imported from FlySpray: https://bugs.openttd.org/task/5022#comment10911

andythenorth closed the ticket.

Reason for closing: Won't implement

Flyspray clean up: more than 5 years old, and not obvious what should be done with this next, so closing. If this offends, discuss with andythenorth in irc. Thanks.

This comment was imported from FlySpray: https://bugs.openttd.org/task/5022