Skip to content

Adding example code to docs #11

@okwme

Description

@okwme

Seems like it should be possible for typedoc to do this automatically but doesn't seem to be a supported feature. I see there's also a command for including examples in JSDoc format but typedoc doesn't support it. Instead they suggest including as code snippets, which sounds like it would also work (TypeStrong/typedoc#135).

Just think it would be nice for example on the tx page to see all of the types actually constructed together once as an example of the object. I find it a lot easier to confirm what you're doing is correct if you're able to just compare the results.

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