tbl_grade_*() functions pass ellipsis to gradethis::fail()

[rossellhayes]

• tbl_grade_*() functions gain the argument ...
• ... is passed to tbl_grade()
• tbl_grade() passes ... to gradethis::fail() (pre-existing behavior)

Closes #67.

[gadenbuie]

In tbl_grade(), instead of

#' @param ... Additional arguments passed to [gradethis::fail()].

can we instead @inheritDotParams gradethis::fail?

[rossellhayes]

@gadenbuie

can we instead @inheritDotParams gradethis::fail?

TIL a new roxygen tag. Updated in 4a0d279.

[gadenbuie]

I'm not sure where I learned about it, it's not mentioned in vignette("rd", "roxygen2"). But you can also specify which arguments are inherited, which I think we want to do in this case, since we don't want message (or others that we set in tbl_grade()) to show up in the list:

#' @inheritDotParams gradethis::fail -message

I found that piece of knowledge in the roxygen2 news: https://github.com/r-lib/roxygen2/blob/7b706c9f7f2e4227c98928a67c5dcb51d88ec15d/NEWS.md#improved-inheritance. (TIL that -message works!)

This is also probably a good time to mention that you can re-use roxygen snippets. Create an .R file in man-roxygen/<snippet-name>.R (e.g. metathis/man-roxygen/describe-meta-return.R) that you can reference in your roxygen documentation with

#' @template describe-meta-return

[rossellhayes]

@gadenbuie I regenerated the documentation with -message. Should we be using a roxygen snippet here, or is that just good to know generally?

[gadenbuie]

@gadenbuie I regenerated the documentation with -message. Should we be using a roxygen snippet here, or is that just good to know generally?

I'm not sure, I just mentioned it because, once you set it up, you wouldn't need to modify 10ish files to adjust it.