aL3xa/rapport — Issue #28: Roxygen usage
Author: daroczig
Created: 2012-01-15 08:57:20+00:00
State: open

I have just updated the roxygen comments to use the `#'` convention instead of unique `##'` in aL3xa/rapport@e8cc9b7 and also did some debugging about `R CMD check` yesterday.

I have found and fixed some not so neat solutions, but there some others left:

* `print` functions should not have any parameters it seems as those not being `@export`ed as normal functions, but being S3 methods. I have cleared up `print.rapport` to [not take arguments](https://github.com/aL3xa/rapport/commit/e8cc9b76a03a0873edea134b730b0fdb66b8b998#L5L149), this should be done in other functions too. We might create a new function instead of `print` and use the parameters there, `print` should stand for default settings. I did not changed anything in @aL3xa's code there as not sure which of other functions use those.
* there are some undocumented functions, which is no good. I see the followings in the check log: `elem.eval.default` and `elem.eval.rp.block`
* besides these only 2 small warning:
* one is about `rp.label<-` which should be (and can be fixed)
* one about `extract.meta`, which is a roxygen bug (?). This should be investigated too. If not manageable, then will have to update the `1.0` release there before sending to CRAN.