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

Feature/179 stan functions listing #180

Merged
merged 6 commits into from
Apr 28, 2020

Conversation

mitzimorris
Copy link
Member

Submission Checklist

  • [x ] Builds locally
  • Declare copyright holder and open-source license: see below

Summary

Python script extract_functions_sig.py scrapes function signatures from HTML comments embedded in Rmd files in src/functions-reference and formats them into sorted listing called stan-functions-MAJ_min.txt.

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company): Columbia University

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

@mitzimorris
Copy link
Member Author

@bgoodri @rok-cesnovar and @serban-nicusor-toptal - where should this script go in the build/release process?

@serban-nicusor-toptal
Copy link
Contributor

Hey, I think in the Jenkinsfile that builds the docs and have it as an Artifact at the end of the build. Is there a need for this file to be put somewhere else by ci/cd ?

@mitzimorris
Copy link
Member Author

who are the external consumers of this info? e.g. RStudio or the maintainer of Stan emacs mode?
cf this comment: https://discourse.mc-stan.org/t/cmdstan-stan-2-23-0-math-3-2-0-released/14516/3?u=mitzimorris

this isn't strictly an rstan thing, so having it live in the rstan repo is weird. I added versioning to the file name thinking it would go somewhere in the release.

Copy link
Member

@rok-cesnovar rok-cesnovar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rok-cesnovar rok-cesnovar merged commit eca89d9 into master Apr 28, 2020
@rok-cesnovar rok-cesnovar deleted the feature/179-stan-functions-listing branch April 28, 2020 15:39
kaz-yos added a commit to jrnold/stan-language-definitions that referenced this pull request Aug 11, 2020
- Now https://github.com/stan-dev/docs has extract_function_sigs.py.
- extract_function_sigs.py can create a function signature file.
- stan-dev/docs#180
- kaz-yos/docs@7ec8511
kaz-yos added a commit to kaz-yos/stan-language-definitions that referenced this pull request Aug 17, 2020
- Now https://github.com/stan-dev/docs has extract_function_sigs.py.
- extract_function_sigs.py can create a function signature file.
- stan-dev/docs#180
- kaz-yos/docs@7ec8511
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 this pull request may close these issues.

None yet

4 participants