Skip to content

PropTypes.exact descriptions flow oddly in some R package docs #799

@rpkyle

Description

@rpkyle

As @shammamah noted in plotly/dash-bio#382, the flow of description strings is somewhat odd. Example: the dashbioCircos.Rd file contains the following information for layout:

\item{layout}{List of lists containing elements 'len', 'color', 'label', 'id'.
those elements have the following types:
  - len (numeric; required): the length of the block.
  - color (character; required): the color of the block.
  - label (character; required): the labels of the block.
  - id (character; required): the id of the block, where it will recieve
data from the specified "track" id.s. The overall layout of the Circos graph, provided
as a list of dictionaries.}

Ideally, the line

The overall layout of the Circos graph, provided as a list of dictionaries.

should follow

List of lists containing elements 'len', 'color', 'label', 'id'.

The R package generation code should be modified to more elegantly handle these descriptions. This may require slightly rewording/modifying the line those elements have the following types.

@alexcjohnson

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