Skip to content

Escape brackets in documentation #380

@VisruthSK

Description

@VisruthSK
✖ helpers-ppc.R:103: @description Could not resolve link to topic "0,1" in the dependencies or base packages.
ℹ If you haven't documented "0,1" yet, or just changed its name, this is normal. Once "0,1" 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.
✖ helpers-ppc.R:524: @param Could not resolve link to topic "0,1" in the dependencies or base packages.
ℹ If you haven't documented "0,1" yet, or just changed its name, this is normal. Once "0,1" 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.
✖ helpers-ppc.R:525: @param Could not resolve link to topic "0,1" in the dependencies or base packages.
ℹ If you haven't documented "0,1" yet, or just changed its name, this is normal. Once "0,1" 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.

#' @param z1 Left evaluation point in [0,1]
#' @param z2 Right evaluation point in [0,1] with z2 > z1.

I think the brackets need to be escaped correctly so they aren't misunderstood to be an empty link.

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