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

Linking to API reference documentation on CRAN #51

Closed
matt-graham opened this issue May 22, 2024 · 3 comments
Closed

Linking to API reference documentation on CRAN #51

matt-graham opened this issue May 22, 2024 · 3 comments

Comments

@matt-graham
Copy link

Raising as part of JOSS review openjournals/joss-reviews/issues/6745

This would perhaps be obvious to a regular R user, but it took me a while to find that there is API documentation for the package available on CRAN. It would be useful to provide a pointer to this in the top-level README (and to the top-level CRAN entry https://cran.r-project.org/web/packages/nimbleHMC/).

@danielturek
Copy link
Member

@matt-graham Yes, that's interesting. Regular R users would be aware of this, but your experience is helpful to hear.

I've added links to this general package information (including the full package API) in PR #55.

@danielturek
Copy link
Member

@matt-graham PR #55 has been merged.

I'll leave it to you to review, and close this issue if you agree it's been addressed.

@matt-graham
Copy link
Author

Looks good, thanks!

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

No branches or pull requests

2 participants