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

RDocumentation outdated for package surveillance #386

Open
bastistician opened this issue Oct 10, 2017 · 7 comments
Open

RDocumentation outdated for package surveillance #386

bastistician opened this issue Oct 10, 2017 · 7 comments

Comments

@bastistician
Copy link

RDocumentation.org knows about the R package surveillance, but only until version 1.12.1 released in May 2016. Meanwhile we arrived at version 1.15.0, see surveillance on CRAN.

Maybe related to #279 and #343.

@bastistician bastistician changed the title RDocumentation is outdated for package surveillance RDocumentation outdated for package surveillance Oct 10, 2017
@ludov04
Copy link
Contributor

ludov04 commented Oct 11, 2017

Seems like there is a problem at parsing time for this package, we'll look into it

@bastistician
Copy link
Author

@filipsch (#399 (comment)):

I would not look into detail into #386.

I was actually hoping that the new version of surveillance (1.16.0, on CRAN since a few days) would trigger a rebuild of the documentation at https://www.rdocumentation.org/packages/surveillance/, but that does not seem to be the case. So I guess that the package parser employed by RDocumentation does not like some of the package's Rd code? Where is the problem? The source code is valid as confirmed by CRAN, and can be parsed by, e.g., https://rdrr.io/cran/surveillance/.

One way to "solve" this issue by myself would be to tweak the problematic Rd code in the next version of surveillance such that it can be parsed by RDocumentation. Of course, this requires me to know where the parser hiccups.

@bastistician
Copy link
Author

Meanwhile I have tracked down several issues in pkgdown, which RDocumentation uses to parse the package. There is still an issue with respect to insufficient support of \Sexpr macros. surveillance will only be parsable once this is fixed.

@ludov04
Copy link
Contributor

ludov04 commented Mar 7, 2018

Thanks @WastlM for investigating this, we are currently in the process of migrating RDoc infrastructure to a new system. That will make it more stable and errors at parsing time will be logged and can be investigated later.

We'll make sure to integrate your fix in the process.
However, we currently lack resources to fix all the issues that pkgdown might run into, we'll try to regularly update pkgdown and integrate the fixes that it contains though

@bastistician
Copy link
Author

Thanks for your efforts! pkgdown 1.0.0 has recently been released, which contains a lot of improvements in rendering the package documentation, e.g., for \Sexpr macros. I have just published surveillance 1.16.1 on CRAN and can confirm that it is now perfectly compatible with pkgdown. Waiting to see if the RDocumentation site for the package finally gets updated as well.

@hermansje
Copy link
Member

RDocumentation for the testwhat package is also not up to date:
https://www.rdocumentation.org/packages/testwhat/versions/4.2.2
https://github.com/datacamp/testwhat/releases

@bastistician
Copy link
Author

@hermansje, you should open a separate issue for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants