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

doc updates #322

Open
13 tasks
richfitz opened this issue Nov 8, 2021 · 0 comments
Open
13 tasks

doc updates #322

richfitz opened this issue Nov 8, 2021 · 0 comments

Comments

@richfitz
Copy link
Member

richfitz commented Nov 8, 2021

  • Description contains reference to wrong rng (or rather, to just one)
  • README contains now-incorrect vignette("cuda") (may be elsewhere)
  • no references to the two new rng vignettes
  • rng vignette add polar to benchmarks, add links to algorithms doc
  • rnguse.cpp package might be stale? who tests this?
  • not sure that I have the right syntax highlighting for c++ blocks, switch to c++ and it should look better
  • off-by-ones in the ziggurat docs
  • the polar and BM methods not really explained
  • "Running this same code in series will give the same results" (dust.Rmd) but we did not set the seed so results are different!
  • better pkgdown structure following https://github.com/r-lib/rlang/blob/main/_pkgdown.yml
  • reference docs for dust_rng's jump method is incorrect in the length of jump
  • errors in distributed doc ("## Error in matrix(r2$state(), 32): object 'r2' not found"), and also not running with errors-are-errors
  • names on set_index is not documented (in run, simulate, set_index) - see Document index naming mcstate#158
@richfitz richfitz added this to the CRAN release (v1.0.x) milestone Nov 8, 2021
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

1 participant