stan-dev / stan-dev/rstantools
Replace `roxygen2::roxygenize()` with `devtools::document()`
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 48
- Forks
- 24
- Avg merge
- 1h 17m
- Merged PRs (30d)
- 1
Description
In the instructions/steps for using devtools here https://github.com/stan-dev/rstantools/blob/99c0d66ae6a78aa10fd16529b0f63c3f3f83e3db/vignettes/minimal-rstan-package.Rmd#L307-L312, you could replace step 3 of using roxygen2::roxygenize() with devtools::document() to keep it pure devtools.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open vignettes/minimal-rstan-package.Rmd around lines 307–312 and read the devtools usage steps. Replace step 3's roxygen2::roxygenize() instruction with devtools::document(), then verify that the vignette consistently presents the pure devtools workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100