Accepted parameters for function not documented

[stairjoke]

Issue with Reference
The page https://getkirby.com/docs/reference/objects/toolkit/collection/sort states:

Sorts the elements by any number of fields

But there is no information on usable parameters. When digging deeper, it becomes clear the function sortBy()-is an alias, and its page contains that the function takes "mixed" arguments.

Based on this documentation, usage of this function is unclear. Should I pass a string, similar to the sorting options in blueprints? Should I pass an array of options—but what options?

Expected
A table giving information about the arguments the function expects, what they mean, and an example of its use.

Screenshots
Table of Parameters on alias function:

This table, unfortunately, is also useless.

[stairjoke]

I asked GPT, I think it got it right? Well its working, we’ll see what happens: https://chatgpt.com/share/67bc5836-9d1c-8002-870c-f20d19f651cc

[lukasbestle]

Hi Wenzel,

Sorry for the late response and thanks for bringing this up. I've already created two issues for our reference:

• v5 reference: $this|static type leads to duplicated class name #2430
• Reference: Respect custom @param definitions for splat param #2431

We have already documented the sorting methods here and will probably also add a link to this recipe to the relevant reference pages: https://getkirby.com/docs/cookbook/collections/sorting