Skip to content

Documentation of parameters is ugly and inconsistent #883

Open
@gibson042

Description

@gibson042

Originally posted by @erights in #876 (comment)

`farName` `{ String }`

What are these curly brackets about? If the intention is to mirror ts-in-jsdoc notation, the parameter name would come after the type, which I agree is unpleasant. How about we use ts notation for types in the docs:

`farName: string`

Metadata

Metadata

Assignees

No one assigned

    Labels

    api-docsissues that generated api-docs should address

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions