Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Supported argument types for reverse? #798

Open
avehtari opened this issue Aug 5, 2024 · 6 comments · May be fixed by #802
Open

Supported argument types for reverse? #798

avehtari opened this issue Aug 5, 2024 · 6 comments · May be fixed by #802

Comments

@avehtari
Copy link
Contributor

avehtari commented Aug 5, 2024

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

@WardBrian
Copy link
Member

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

@avehtari
Copy link
Contributor Author

avehtari commented Aug 5, 2024

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

@WardBrian
Copy link
Member

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

@bob-carpenter
Copy link
Contributor

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.

@avehtari
Copy link
Contributor Author

avehtari commented Aug 5, 2024

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)

@bob-carpenter
Copy link
Contributor

add a cross-link?

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants