Skip to content

Add TSDoc comments to describe arguments/props so the descriptions will appear in IntelliSense #113

@mturley

Description

@mturley

https://tsdoc.org/ is a good way to document the use of each argument/prop in a function/component, and those comments will appear when typing a function call in an editor that supports IntelliSense (such as VS Code).

We could add general descriptions of each prop, but we can also use that as a place for recommendations/warnings about the use of certain props (see #112 for an example).

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