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

generate function signature listing from markdown (stan-functions.txt) #179

Closed
mitzimorris opened this issue Apr 27, 2020 · 3 comments
Closed
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@mitzimorris
Copy link
Member

Summary:

Generate a listing of functions signatures from the documentation for use with RStan and Stan emacs mode via a python script (roughly) along the lines of existing build scripts add_redirects.py, link_to_latest.py.

Description:

The index of the functions reference pdf was used as the basis of the file stan-functions.txt; when moving to markdown, html comment tags were added which captured the equivalent information in the markdown files, e.g.:

> grep '<!-- ' src/functions-reference/covariance_matrix_distributions.Rmd 
<!-- real; wishart ~; -->
<!-- real; wishart_lpdf; (matrix W | real nu, matrix Sigma); -->
<!-- matrix; wishart_rng; (real nu, matrix Sigma); -->
<!-- real; inv_wishart ~; -->
<!-- real; inv_wishart_lpdf; (matrix W | real nu, matrix Sigma); -->
<!-- matrix; inv_wishart_rng; (real nu, matrix Sigma); -->

Additional Information:

Soliciting input as to most useful file format from community via Discourse.

Current Version:

v2.18.0

@mitzimorris mitzimorris self-assigned this Apr 27, 2020
@mitzimorris mitzimorris added enhancement New feature or request question Further information is requested labels Apr 27, 2020
@mitzimorris
Copy link
Member Author

@bgoodri - would prefer to do this instead of #128 - is this OK with you?

@bgoodri
Copy link

bgoodri commented Apr 27, 2020 via email

@WardBrian
Copy link
Member

This was resolved by #180

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants