Skip to content

Warning for unknown topic in internal noRd page #1727

@MichaelChirico

Description

@MichaelChirico

When writing @noRd documentation, I didn't expect roxygen2 to actually check it with any real vigor, but updating to 7.3.3 found a new issue:

#' @param See [other_undocumented_function()]
one_internal_function <- function() ...

Now produces a warning like:

✖ get_source_expressions.R:277: @param Could not resolve link to topic "other_undocumented_function" in the dependencies or base packages.
ℹ If you haven't documented "other_undocumented_function" yet, or just changed its name, this is normal. Once "other_undocumented_function" is documented, this
  warning goes away.
ℹ Make sure that the name of the topic is spelled correctly.
ℹ Always list the linked package as a dependency.
ℹ Alternatively, you can fully qualify the link with a package name.

Is this WAI?

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