Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@format cannot be inherited #1293

Closed
netique opened this issue Feb 23, 2022 · 2 comments · Fixed by #1531
Closed

@format cannot be inherited #1293

netique opened this issue Feb 23, 2022 · 2 comments · Fixed by #1531
Labels
feature a feature request or enhancement inherit 👨‍👩‍👧‍👦
Milestone

Comments

@netique
Copy link

netique commented Feb 23, 2022

I want to inherit a format tag from a dataset of foreign package, but @inherit foo::bar format seems to do nothing. Minimal example (functions in the same NS):

library(roxygen2)
roc_proc_text(rd_roclet(), "
#' Foo
#' 
#' @format BLAH
foo <- function() {}

#' Bar
#' 
#' @inherit foo format
bar <-  function(x){}
")

This also seems to affect example and example tags.

@hadley hadley added feature a feature request or enhancement inherit 👨‍👩‍👧‍👦 labels Mar 29, 2022
@hadley
Copy link
Member

hadley commented Apr 6, 2022

Not exactly nothing: it tells you that format isn't supported yet:

library(roxygen2)
x <- roc_proc_text(rd_roclet(), "
#' Foo
#' 
#' @format BLAH
foo <- function() {}

#' Bar
#' 
#' @inherit foo format
bar <-  function(x){}
")
#> Warning: [<text>:9] @inherit Unknown inherit type: format

Created on 2022-04-06 by the reprex package (v2.0.1)

@netique
Copy link
Author

netique commented Apr 6, 2022

Ahh, my bad, missed that somehow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement inherit 👨‍👩‍👧‍👦
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants