Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Duplication in callback/callable/function properties. #581

Closed
Shakeskeyboarde opened this issue Feb 25, 2024 · 2 comments
Closed

Duplication in callback/callable/function properties. #581

Shakeskeyboarde opened this issue Feb 25, 2024 · 2 comments

Comments

@Shakeskeyboarde
Copy link

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
@tgreyuk
Copy link
Member

tgreyuk commented Feb 25, 2024

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 tgreyuk added the next Fix available in the '@next' release label Feb 25, 2024
@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

typedoc-plugin-markdown@4.0.0

@tgreyuk tgreyuk closed this as completed May 3, 2024
@tgreyuk tgreyuk removed the next Fix available in the '@next' release label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants