-
Notifications
You must be signed in to change notification settings - Fork 234
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 fails to generate method documentation #261
Comments
Hi Summary of where the problem emerges
That is where the problem arises if the .Rd file for the generic does not already exist. An error is raised, and eventually devtools::document() falls over. If the help file for the generic is found, eval returns something which makes the rest of the code happy. |
… to date I have experienced a couple of related issues using the devtools / roxygen2 combination to develop and document a package. Both issues relate to inheritance, and the file collation order for the package (which roxygen2 very nicely generates from the @include tags in the roxygen comments in my R code). I am using devtools 1.5.0.99 and roxygen2 4.0.1 For details of the issues see : 1) issue 261 , devtools::load_all not happy : r-lib/roxygen2#261 https://groups.google.com/forum/#!topic/rdevtools/N3wy684ccnA https://groups.google.com/forum/#!topic/rdevtools/2TMDbDcPNA8 and 2) issue related to order of (inherited) parameters in documentation from roxygen2 https://groups.google.com/forum/#!topic/rdevtools/KBd7X8UbqPg These issues would be solved if : 1) devtools::load_all updated the Collate field in the description file before attempting to load and evaluate the R code in the package and 2) roxygen2::roxygenise read in and parsed the roxygen comment blocks from R files in the order of the Collate sequence instead of from R files in alphabetical filename sequence. I have tried some 'proof of concept' tweaks to devtools::loadall and roxygen2::roxygenise to trial this, and they do solve my immediate problem. My solutions are not as elegant and concise as the master devtools and roxygen code (which is awesome!), and have not been tested in other 'use cases', nor for efficiency, nor for other platforms (I am on Windows 7). But perhaps they will be useful small contribution as a rough starting point for other more experienced coders. Regards Geoff Lee
Hi I have experienced a couple of related issues using the devtools / roxygen2 combination to develop and document a package. Both issues relate to inheritance, and the file collation order for the package (which roxygen2 very nicely generates from the @include tags in the roxygen comments in my R code). I am using devtools 1.5.0.99 and roxygen2 4.0.1 For details of the issues see : 1) issue 261 , devtools::load_all not happy : r-lib#261 https://groups.google.com/forum/#!topic/rdevtools/N3wy684ccnA https://groups.google.com/forum/#!topic/rdevtools/2TMDbDcPNA8 and 2) issue related to order of (inherited) parameters in documentation from roxygen2 https://groups.google.com/forum/#!topic/rdevtools/KBd7X8UbqPg These issues would be solved if : 1) devtools::load_all updated the Collate field in the description file before attempting to load and evaluate the R code in the package and 2) roxygen2::roxygenise read in and parsed the roxygen comment blocks from R files in the order of the Collate sequence instead of from R files in alphabetical filename sequence. I have tried some 'proof of concept' tweaks to devtools::loadall and roxygen2::roxygenise to trial this, and they do solve my immediate problem. My solutions are not as elegant and concise as the master devtools and roxygen code (which is awesome!), and have not been tested in other 'use cases', nor for efficiency, nor for other platforms (I am on Windows 7). But perhaps they will be useful small contribution as a rough starting point for other more experienced coders. Regards Geoff Lee
roxygen2 fails to generate documentation for a simple S4 method with only one parameter. I am giving example code with class A and method B below:
The text was updated successfully, but these errors were encountered: