docs icon indicating copy to clipboard operation
docs copied to clipboard

Supported argument types for reverse?

Open avehtari opened this issue 1 year ago • 6 comments

reverse function doc https://mc-stan.org/docs/functions-reference/matrix_operations.html#reverse-functions says the input needs to be a vector or row_vector, but it seems to work also with array

avehtari avatar Aug 05 '24 12:08 avehtari

This is a problem we’ve had several times based on the current organization of the docs. It does work for arrays, and this is documented (https://mc-stan.org/docs/functions-reference/array_operations.html#reversing-functions) but on a separate page, which makes discoverability hard

WardBrian avatar Aug 05 '24 12:08 WardBrian

Uh, I googled "stan reverse array" and the first link is to matrix_operations.html

avehtari avatar Aug 05 '24 12:08 avehtari

Yes, the current chapter structure of the functions isn't very good for google. The internal search bar does turn up all the valid options still, but it's definitely not ideal

WardBrian avatar Aug 05 '24 13:08 WardBrian

Any suggestions on how we could make the structure better? In many ways, one function per page would be nice, but then we don't see related things like all the normal distribution functions. And there wouldn't be an easy way to scan all the matrix functions that way.

bob-carpenter avatar Aug 05 '24 16:08 bob-carpenter

Maybe just add a cross-link? That is, matrix_operations.html#reverse-functions could say:

See also reverse functions for arrays and complex matrices.

(with hyperlinks to appropriate places, but I expect that github comment doesn't show them right)

avehtari avatar Aug 05 '24 18:08 avehtari

add a cross-link?

Yes, please. That'd certainly be an improvement on what we have now.

bob-carpenter avatar Aug 05 '24 18:08 bob-carpenter