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

Adding a link to example usage in nimble documentation to README #48

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

Comments

@matt-graham
Copy link

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

After a bit of searching I was able to find an example of using nimbleHMC in the main nimble user manual. While the line

See the [nimble website](https://r-nimble.org/) for more information and examples.

does provide a general pointer to the nimble website (and so user manual), it would be good to have a specific link to the example nimbleHMC usage somewhere to aid users wanting to get started with using nimbleHMC, or including a self-contained example in the README (though appreciate you might not want to have the resulting repetition / need to keep the examples in two places in sync with API changes).

@danielturek
Copy link
Member

@matt-graham Great comment. This is addressed in PR #52.

I opted for adding a link to the user manual, so that we can avoid maintaining examples in multiple different places.

@danielturek
Copy link
Member

@matt-graham PR #52 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

Thanks looks good to me!

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