Skip to content

Documented object properties are not displayed #765

@sandydoo

Description

@sandydoo

One example is the deprecate method. I often forget what the options are and which of them are required. The current docs don’t show them, but they are documented in the source. I'm not sure if there are any more examples like this.

Proposal

I propose we display these props. An indent should be enough to differentiate them from the function arguments.

Screenshots

Before

before

After

after

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