Disable roxygen comments processing for unavailable methods #342
Conversation
I had been looking at outdated sample code which included a use of "create_dot_body" which has been used as a sub-method for plot.grf_tree since. As "create_dot_body" was listed in the 00index.html, I was under the assumption it should be available as a method even though it was not. Maybe this will help prevent confusion of that kind while still maintaining the commentary. Would this comply with the GRF coding/documentation practices?
|
Thanks @jakobzeitler for catching this issue. I think that instead of disabling roxygen processing altogether, we should add the tag I was also wondering what outdated sample code you encountered (in case there's an example we should make sure to update somewhere)? |
|
Thanks for the response, Julie. I had been looking for the @Keyword internal to solve this, thanks for pointing that out! I was also looking for the example code I used, that included the "create_dot_body", but I have not found it, yet. (A repository wide search did not return anything, so it must have originated somewhere outside). I will let you know when it comes back to my mind. |
|
I have added the keyword to the plot.R. Do you have any other methods in mind that would require that keyword? I can add it there as well, if required. |
In #342 we tried to exclude private helper methods from being included in the package documentation. However we accidentally used `@keyword` instead of the valid directive `@keywords`.
In #342 we tried to exclude private helper methods from being included in the package documentation. However we accidentally used `@keyword` instead of the valid directive `@keywords`.
In #342 we tried to exclude private helper methods from being included in the package documentation. However we accidentally used `@keyword` instead of the valid directive `@keywords`.
In grf-labs#342 we tried to exclude private helper methods from being included in the package documentation. However we accidentally used `@keyword` instead of the valid directive `@keywords`.
I had been, unfortunately, looking at outdated sample code for grf which included a use of "create_dot_body" which has been moved into a sub-method for plot.grf_tree since. As "create_dot_body" was listed in the 00index.html, I was under the assumption it should be available as a method even though it was not. Maybe this commit will help prevent confusion of that kind while still maintaining the commentary for development purposed. Would this comply with the GRF coding/documentation practices?