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

roxygen2 version 6.0.0 warnings for reference class documentation #571

Closed
christophergandrud opened this issue Jan 31, 2017 · 4 comments
Closed

Comments

@christophergandrud
Copy link

I just upgraded to version 6.0.0 and am now getting a similar series of warnings for a package's reference class documentation, e.g.:

Updating Zelig documentation
Loading Zelig
Warning: @import [model-zelig.R#6]: unknown tag
Warning: @export [model-zelig.R#7]: unknown tag
Warning: @exportClass [model-zelig.R#8]: unknown tag
Warning: @import [model-timeseries.R#4]: unknown tag
Warning: @export [model-timeseries.R#5]: unknown tag
Warning: @exportClass [model-timeseries.R#6]: unknown tag
Warning: @export [model-timeseries.R#150]: unknown tag
Warning: @import [model-ma.R#5]: unknown tag
Warning: @export [model-ma.R#6]: unknown tag
Warning: @exportClass [model-ma.R#7]: unknown tag
Warning: @import [model-ar.R#5]: unknown tag
Warning: @export [model-ar.R#6]: unknown tag
Warning: @exportClass [model-ar.R#7]: unknown tag
and so on.

Any idea what's going on. (I'ld be happy to provide sessionInfo, etc if that would help.)

This should be reproducible with:

library(devtools)
install_github('IQSS/Zelig')
document(roclets=c('rd'))
@hadley
Copy link
Member

hadley commented Jan 31, 2017

It's because of this: document(roclets=c('rd')) — those tags are all namespace tags, and since you're not using the namespace roclet, it doesn't know about the tags.

@christophergandrud
Copy link
Author

Ah, got it. So the behaviour hasn't changed, but the warning is new?

@hadley
Copy link
Member

hadley commented Jan 31, 2017

Right — previously all tags were always registered, regardless of what roclets were used. Now each roclet is in charge of registering the tags that it uses.

@christophergandrud
Copy link
Author

Thanks for the info.

tpilz added a commit to tpilz/lumpR that referenced this issue Apr 27, 2017
Since roxygen 6.0.0 I got warnings about unused tags (see also r-lib/roxygen2#571 ) which shall be removed with this commit.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants