Skip to content

Commit

Permalink
Correct @inheritParams vs `@inheritDotParams template
Browse files Browse the repository at this point in the history
  • Loading branch information
olivroy committed Jul 7, 2023
1 parent a34bdf7 commit 0171dfa
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions inst/roxygen2-tags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -218,15 +218,15 @@
description: >
Automatically generate documentation for `...` when you're passing dots
along to another function.
template: ' ${1:source} ${2:arg1 arg2 arg3}'
template: ' ${1:source}'
vignette: reuse
recommend: true

- name: inheritParams
description: >
Inherit argument documentation from another function. Only inherits
documentation for arguments that aren't already documented locally.
template: ' ${1:source}'
template: ' ${1:source} ${2:arg1 arg2 arg3}'
vignette: reuse
recommend: true

Expand Down

0 comments on commit 0171dfa

Please sign in to comment.