Skip to content

Commit 5b7110d

Browse files
Fix 3 typos in @describeIn section (#1611)
of the Reusing documention vignette
1 parent ff7cd53 commit 5b7110d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

vignettes/reuse.Rmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ ln <- function(x) log(x, exp(1))
9090

9191
An alternative to `@rdname` is `@describeIn`.
9292
It has a slightly different syntax because as well as a topic name, you also provide a brief description for the function, like `@describein topic one sentence description`.
93-
The primary difference between `@rdname` and `@describeIn`, is that `@describeIn` creates a new section containing a bulleted list all of each function, along with its description.
94-
It uses a number of heuristics to determine the heading of this section, depending on you're documenting related functions, methods for a generic, or methods for a class.
93+
The primary difference between `@rdname` and `@describeIn`, is that `@describeIn` creates a new section containing a bulleted list of each function, along with its description.
94+
It uses a number of heuristics to determine the heading of this section, depending on if you're documenting related functions, methods for a generic, or methods for a class.
9595

9696
In general, I no longer recommend `@describeIn` because I don't think the heuristics it uses are as good as a thoughtful hand-crafted summary.
97-
If you're currently using `@describeIn`, you can general replace it with `@rdname`, as long as you give some thought to the multiple-function `@description`.
97+
If you're currently using `@describeIn`, you can generally replace it with `@rdname`, as long as you give some thought to the multiple-function `@description`.
9898

9999
### Order of includes
100100

0 commit comments

Comments
 (0)