typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

Duplication in callback/callable/function properties.

Open Shakeskeyboarde opened this issue 1 year ago • 1 comments
trafficstars

Properties that have a function type, include a "Type Declaration" section that I would like to omit. Even though it's a function value, it's first and foremost a property, and I want it to appear the same as other non-function valued properties.

I've attached a screenshot illustrating what I mean. The dir property has no duplication. The getDependencyLinks property shows the function signature and description twice, as well as "Parameters" and "Returns" subsections which I think are unnecessary. If I wanted to have detailed documentation about the function type, I would declare it as a type alias, instead of having it inlined.

Screenshot 2024-02-24 at 6 47 01 PM

Shakeskeyboarde avatar Feb 25 '24 02:02 Shakeskeyboarde

Thank you. This has actually already been fixed in typedoc-plugin-markdown@next . Will leave this issue open though until v4 is released (not sure the fix will make it into v3).

tgreyuk avatar Feb 25 '24 23:02 tgreyuk

[email protected]

tgreyuk avatar May 03 '24 16:05 tgreyuk