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

need html comments for all signatures for built-in functions #42

Closed
mitzimorris opened this issue Apr 11, 2019 · 8 comments
Closed

need html comments for all signatures for built-in functions #42

mitzimorris opened this issue Apr 11, 2019 · 8 comments
Assignees
Labels
bug Something isn't working
Milestone

Comments

@mitzimorris
Copy link
Member

mitzimorris commented Apr 11, 2019

Summary:

Conversion from latex to Rmd failed to register signatures some functions. also missing entries for sampling statements for distributions.

Description:

Every function signature should have an accompanying HTML comment, e.g.:

<!-- real; min; (real[] x); -->
<!-- int; min; (int[] x); -->

Comparison to info scraped from latex index indicates about 50 missing signatures - need to check out 2.18.1 release, run task make manual, and examine file doc/stan-functions-2.18.1.txt

Additional Information:

Current Version:

v2.19.0

@mitzimorris mitzimorris added this to the 2.19++ milestone Apr 11, 2019
@mitzimorris mitzimorris self-assigned this Apr 11, 2019
@mitzimorris mitzimorris added the bug Something isn't working label Apr 11, 2019
@bgoodri
Copy link

bgoodri commented Apr 11, 2019

Also, binomia\_l is missing an l in several places, such as
https://github.com/stan-dev/docs/blob/master/src/functions-reference/bounded_discrete_distributions.Rmd#L55

@mitzimorris
Copy link
Member Author

@bgoodri - 53 missing entries are for sampling statements on distributions -

when adding these back in, it would be possible to add info about params, e.g. instead of:

bernoulli;~;real;92

we could do:

<!-- real; bernoulli; ~ reals theta; -->

@mitzimorris
Copy link
Member Author

just merged #43 - @bgoodri - now there are 724 entries in the form of HTML comments for all built-in functions, distributions, and sampling statements.
in 2.18.1, there were redundant entries for the "abs" function - should be 1, not 3 entries.

@bgoodri
Copy link

bgoodri commented Jan 12, 2020

I have a local branch that makes stan-functions.txt using Python.

@mitzimorris
Copy link
Member Author

who should we talk to at RStudio to clear this up?
@bgoodri - what do you do with the stan-functions.txt file?

@bgoodri
Copy link

bgoodri commented Jan 13, 2020 via email

@mitzimorris
Copy link
Member Author

sounds good - how about checking that python script into docs? what's a good name - 'list_stan_function' or similar?

@bgoodri
Copy link

bgoodri commented Jan 13, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants