Skip to content

Commit b294d63

Browse files
authored
Cross-link to advice elsewhere (#1857)
Fixes #1856
1 parent 41fd0c9 commit b294d63

1 file changed

Lines changed: 2 additions & 4 deletions

File tree

vignettes/extending.Rmd

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -231,10 +231,8 @@ Note that there is no namespacing so if you're defining multiple new tags I reco
231231
### Using your new tag
232232

233233
Now that the three methods are created, we still need to make them available to `roxygenize()`.
234-
First, you need to export the method:
235-
236-
- If the package defining the tag *imports* roxygen2, use `@export`.
237-
- If the package defining the tag only *suggests* roxygen2, use `@exportMethod`.
234+
First, you need to export the method so that it's registered correctly.
235+
Since your methods will be for generics defined in roxygen2 (another package), you'll need to follow the advice in [Methods for generics in other packages](rd-S3.html#methods-for-generics-in-other-packages).
238236

239237
Next, you'll need to load the tag-defining package in the package where you want to use it.
240238
For example, if you created some new tags in {packageFoo}, and would like to use these tags in your documentation for {packageBar}, append this line to the `DESCRIPTION` of {packageBar}:

0 commit comments

Comments
 (0)