Skip to content

Commit

Permalink
fix some docs typos (#764)
Browse files Browse the repository at this point in the history
  • Loading branch information
maxheld83 authored and gaborcsardi committed Jul 30, 2018
1 parent cd11f9e commit df88ae1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions vignettes/rd.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ add(10, 1)

Rd files are a special file format loosely based on LaTeX. You can read more about the Rd format in the [R extensions](https://cran.r-project.org/doc/manuals/R-exts.html#Rd-format) manual. With roxygen2, there are few reasons to know about Rd files, so here I'll avoid discussing them as much as possible, focussing instead on what you need to know about roxygen2.

When you use `?x`, `help("x")` or `example("x")` R looks for an Rd file containing `\alias{x}`. It then parses the file, converts it into html and displays it. These functions look for an Rd file in _installed_ packages. This isn't very useful for package development, because you want to use the `.Rd` files in the _source_ package. For this reason, we recommend that you use roxygen2 in conjunction with devtools: `dwevtools::load_all()` automatically adds shims so that `?` and friends will look in the development package. Note, however, that this preview does not work with intra-package links. To preview those, you'll need to install the package. If you use RStudio, the easiest way to do this is to click the "Build & Reload button".
When you use `?x`, `help("x")` or `example("x")` R looks for an Rd file containing `\alias{x}`. It then parses the file, converts it into html and displays it. These functions look for an Rd file in _installed_ packages. This isn't very useful for package development, because you want to use the `.Rd` files in the _source_ package. For this reason, we recommend that you use roxygen2 in conjunction with devtools: `devtools::load_all()` automatically adds shims so that `?` and friends will look in the development package. Note, however, that this preview does not work with intra-package links. To preview those, you'll need to install the package. If you use RStudio, the easiest way to do this is to click the "Build & Reload button".

## Basics

Expand Down Expand Up @@ -109,7 +109,7 @@ We'll discuss that more in [formatting](formatting.html). Also note the wrapping

## Object specifics

Further details of roxygen2 depend on what you're documenting. You use use __tags__ like `@tag details`. Tags must start at the beginning of a line, and the content of a tag extends to the start of the next tag (or the end of the block). The following sections describe the most commonly used tags for functions, S3, S4, and RC objects and data set.
Further details of roxygen2 depend on what you're documenting. You use __tags__ like `@tag details`. Tags must start at the beginning of a line, and the content of a tag extends to the start of the next tag (or the end of the block). The following sections describe the most commonly used tags for functions, S3, S4, and RC objects and data set.

### Functions

Expand Down Expand Up @@ -270,7 +270,7 @@ Package documentation should be placed in `pkgname.R`. Here's an example:
"_PACKAGE"
```

I recommend using `@keyword internals` for package documentation.
I recommend using `@keywords internal` for package documentation.

Some notes:

Expand Down

0 comments on commit df88ae1

Please sign in to comment.