Skip to content

Removing the parameters list, including the title #876

Description

@Jym77

What package is the feature request related to?

typedoc-plugin-markdown

Background

When parameters are expanded (expandParameters option), the parameters list or table makes less sense (lot of duplicated information). While we can easily get rid of the list/table through the parametersList or parametersTable partials (making them return the empty string), the signature partial still always adds the heading resulting in a weird empty #### Parameters section. Comparatively, the return value can be totally dumped (including the heading) through the signatureReturns partial.


PS: Thanks for the plugin. I love it. I'm only spamming issues because I am using it 😁

Proposed solution

I think here what would make the most sense would be to have the paramatersFormat option accept a value of none with the meaning of "don't even show the section heading". Looks like it should also control the type parameters since they are both controlled by this option currently. Not sure whether other *Format options also make sense with a none value.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions