bcgov / climr

An R package for downscaling monthly climate data for North America
https://bcgov.github.io/climr/
14 stars 6 forks source link

Documentation for @noRd functions #110

Open CeresBarros opened 7 months ago

CeresBarros commented 7 months ago

There are a few functions in climr that have little or no documentation and for which no documentation file (the .Rd file) is built (@noRd).

I think that it would be useful to try to 9almost) fully document these functions (description, parameters and imports), even if it's not going to be visible to package users, as this could facilitate future development (especially by new developers).

What do you think @kdaust, @cmahony ?

kdaust commented 7 months ago

Absolutely! But probably a lower priority than the ones that are accessible to users

cmahony commented 7 months ago

yes, agreed. thanks ceres.