Skip to content

Commit

Permalink
Merge pull request #242 from PeteHaitch/patch-1
Browse files Browse the repository at this point in the history
Update roxygen2.Rmd
  • Loading branch information
hadley committed May 1, 2014
2 parents f609e41 + d2a24c1 commit 2005675
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions vignettes/roxygen2.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ This vignette provides a high-level description of roxygen2 and how the three ma

There are three main ways to run roxygen:

* `roxygen::roxygenise()`, or
* `roxygen2::roxygenise()`, or

* `devtools::document()`, if you're using devtools, or

* `Ctrl + Shift + D`, if you're using RStudio.

As of version 4.0.0, roxygen2 will never overwrite a file it didn't create. It does this by labelling every file it creates with a comment: "Generated by roxygen2 (4.0.0): do not edit by hand". To upgrade from a previous version of roxygen2, you'll need to first run `roxygen::upgradeRoxygen()`. This deletes all `.Rd` and labels the `NAMESPACE` as being created by roxygen2.
As of version 4.0.0, roxygen2 will never overwrite a file it didn't create. It does this by labelling every file it creates with a comment: "Generated by roxygen2 (4.0.0): do not edit by hand". To upgrade from a previous version of roxygen2, you'll need to first run `roxygen2::upgradeRoxygen()`. This deletes all `.Rd` and labels the `NAMESPACE` as being created by roxygen2.

0 comments on commit 2005675

Please sign in to comment.