search

nc-minibbs / mbbs

A repository for the Mini-Bird Breeding Survey data
https://minibbs.us
Other
2 stars 0 forks source link

@Exports -> @returns #59

Closed IJBG closed 2 months ago

IJBG commented 3 months ago

find R/ functions that are incorrectly using "@"Exports and change them to "@"returns

bsaul commented 3 months ago

FWIW (this might be why you opened the issue), in terms of Roxygen comments, #' @exports is a directive to make the function available to library users (i.e. when the package is build a function tagged with @export is added as an export in the NAMESPACE file automatically. #' @returns is simply a documentation directive to tell users what the function is supposed to return when called.

IJBG commented 3 months ago

Yep! I overused it in process_observers :)