search

extendr / rextendr

An R package that helps scaffolding extendr-enabled packages or compiling Rust code dynamically
https://extendr.github.io/rextendr/
Other
184 stars 27 forks source link

Don't generate .Rd pages for internal functions #71

Closed clauswilke closed 3 years ago

clauswilke commented 3 years ago

A few internal functions are currently documented using roxygen2, so man pages are generated. I think we should turn off man page generation. This generally means replacing #' with # at the beginning of each line.

These are the cases I'm aware of:

https://github.com/extendr/rextendr/blob/74817048d578c640e77df740e1fa00071320a011/R/register_extendr.R#L85-L100

https://github.com/extendr/rextendr/blob/74817048d578c640e77df740e1fa00071320a011/R/register_extendr.R#L120-L126

clauswilke commented 3 years ago

Also: https://github.com/extendr/rextendr/blob/74817048d578c640e77df740e1fa00071320a011/R/ui.R#L1-L90

yutannihilation commented 3 years ago

How about just replacing @keywords internal with @noRd?

clauswilke commented 3 years ago

Ah, I wasn't aware this existed. Sure, works for me.