Documentation of internal functions

[rklasky]

Comments for internal functions don't seem to be visible after running pkgdown. Anyone know any way to view the comments for internal functions?

[andybeet]

So internal functions should be commented the same way as exported functions with a couple of "additional" tags. (the @keywords and the @noRd). Internal functions by design aren't meant to be visible to the user so they wouldn't appear in pkgdown but the documentation will still be useful for future developers. Format eg.

#' Title
#' 
#' Description
#' 
#' @keywords internal
#' 
#' @param name desc
#' 
#' @returns description
#' 
#' @noRd

The @noRd tag will prevent documentation being made.
Internal functions should not have an @export tag

In short: I wouldn't worry about the external visibility of these functions as long as they are documented similarly as exported

[rklasky]

Looks like returns is superseding return? Did you see that in the Roxygen docs? https://roxygen2.r-lib.org/reference/tags-rd.html

[andybeet]

You are right, that was a typo. i'll fix it

[rklasky]

Thanks. This is very helpful.

…

On Tue, Feb 4, 2025 at 8:38 AM Andy Beet ***@***.***> wrote: So internal functions should be commented the same way as exported functions with a couple of "additional" tags. (the @Keywords and the @nord). Internal functions by design aren't meant to be visible to the user so they wouldn't appear in pkgdown but the documentation will still be useful for future developers. Format eg. #' Title #' #' Description #' #' @Keywords internal #' #' @param name desc #' #' @return description #' #' @nord The @nord tag will prevent documentation being made. Internal functions should not have an @export tag In short: I wouldn't worry about the external visibility of these functions as long as they are documented similarly as exported — Reply to this email directly, view it on GitHub <#105 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGZ6RSFAX4HOZIOY4BCIULT2OC7GDAVCNFSM6AAAAABWNTKMPGVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEMBVGUZDENY> . You are receiving this because you authored the thread.Message ID: ***@***.***>

-- Ron Klasky Contractor (remote) T and T Consulting Services, Inc. In Support of Office of Science and Technology | Ecosystem Management NOAA | National Marine Fisheries Service (321) 765-4465 (o) (661) 857-4720 (c)