Replace `roxygen2::roxygenize()` with `devtools::document()`

Open Beginner friendly
#131 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
r
Domain
documentation

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.

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.

Dominant language
R
Stars
48
Forks
24
Avg merge
1h 17m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stan-dev/rstantools

All issues in stan-dev/rstantools

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.