Skip to content

get_vpts_rmi, req_cache_getRad and get_vpts_aloft are in cran documentation #178

Closed

Description

@bart1

see here: https://cran.r-project.org/web/packages/getRad/refman/getRad.html#get_vpts_aloft

It seems the are not in the pdf documentation. However maybe it is better to use @noRd instead of @keywords internal to prevent this from happening?

@PietrH any objections?

Activity

  1. PietrH commented on May 22, 2026

    @PietrH
    Contributor

    We use @noRd for this all the time, seems to fit the bill in this case.

    Internal functions do get their documentation rendered, but are not made visible to a user unless they ask. If you add @noRd then the documentation doesn't even get rendered.

    It depends on the usecase, it's not too big a deal if they are in the CRAN docs either IMHO. But I suppose @noRd is cleaner

  2. added a commit that references this issue on May 26, 2026
    58881cf
  3. bart1 commented on May 26, 2026

    @bart1
    CollaboratorAuthor

    It seems @keywords internal is mostly for exported functions (e.g. https://github.com/search?q=org%3Atidyverse%20keywords%20internal&type=code) now as long as it is in the index of CRAN if that is resolved we can revert these changes

    Also see: https://recology.info/2025/02/r-examples-internal/#other-thoughts

  4. added 2 commits that reference this issue on Jun 2, 2026
    d0f69f6
    46e67bc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions