Skip to content

<URLs> in Description field don't show up on package landing pages #347

@hpages

Description

@hpages

According to the Writing R Extensions manual, URLs in a package Description field should be enclosed in angle brackets. See https://cran.r-project.org/doc/manuals/r-release/R-exts.html#The-DESCRIPTION-file

Note that this is enforced on CRAN via R CMD check's option --as-cran. See for example https://cran.r-project.org/package=crul or https://cran.r-project.org/package=Rtwobitlib.

Unfortunately, when used in a Bioconductor package, these URLs enclosed in angle brackets don't get displayed on the package landing page. See for example https://bioconductor.org/packages/igblastr where the 2 URLs present in the Description field are missing.

Note that the angle-bracketed URLs do show up in the HTML source of the page but the angle brackets are not escaped, hence why they're not rendered and the text inside them is not rendered either. FWIW the standard way to address this is to replace them with HTML entities &lt; and &gt;. For example in Python this is taken care of by passing the text to display thru html.escape():

>>> import html
>>> html.escape('<https://google.com/>')
'&lt;https://google.com/&gt;'

Thanks,
H.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions