USEPA / SSN2

SSN2: Spatial Modeling on Stream Networks in R
https://usepa.github.io/SSN2/
GNU General Public License v3.0
16 stars 3 forks source link

suggestion: roxygen documentation for non-exported functions #17

Closed k-doering-NOAA closed 5 months ago

k-doering-NOAA commented 8 months ago

This is only a non-blocking suggestion to help with maintenance in the future.

I noticed some functions that aren't exported are missing roxygen documentation. For example,

https://github.com/USEPA/SSN2/blob/6b634c5ac1ce66195db5cbdec6c9ac3d10bee46a/R/amongSitesDistMat.R#L1-L4

The comments on lines 2-4 could instead be turned into roxygen documentation, which would be more explicit about what the function does and what the variables are. This can benefit future maintainers so it is easier to remember (or learn for the first time) the purpose of the function.

michaeldumelle commented 5 months ago

Thank you for the feedback @k-doering-NOAA! I will respond in this post which I will edit as I progress through documenting non-exported functions. Please reach out if you have any questions/comments/concerns!

We have added roxygen documentation for all non-exported functions, which includes functions in: