dev_guide Specify the use of `#' @keywords internal`

@mpadge, @maelle, I made a suggestion as a folow-up to our discussion in https://github.com/ropensci/statistical-software-review-book/discussions/44#discussioncomment-13698125

I hope this helps.

Jul 09 '25 08:07 cforgaci

That's great @cforgaci, and thanks for responding so promptly. Can you may rearrange the sentence, especially to avoid starting with a negative implication, "aren't worth documenting ...". I think it would be better to first suggest @keywords internal, with a description of what that does (might be best to quote and link to roxygen2 docs:

flags the topic as internal and removes from topic indexes

Then say if you don't want any fn docs generated at all, use @noRd.

Jul 09 '25 08:07 mpadge

@mpadge I updated the text as you suggest. I also removed

Note that functions with #' @keywords internal do not require an #' @example section for CRAN submission.

It is good a use case of #' @keywords internal, but it might be an unnecessary side note here.

Jul 09 '25 09:07 cforgaci

@maelle I've approved here -feel free to suggest any additional tweaks, otherwise please merge :heavy_check_mark:

Jul 09 '25 09:07 mpadge

I do like the change as it is now, thank you! I'll wait for #952 to be merged before adding translations to this PR. Thanks for your patience.

Sep 23 '25 10:09 maelle

Thanks everyone!!

Nov 03 '25 09:11 maelle