-
Notifications
You must be signed in to change notification settings - Fork 179
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
Type for optional array element not hyperlinked #719
Comments
Hi @tgreyuk - Thanks for the quick response on this, greatly appreciated! In the repro provided, all looks good! Unfortunately, when the type includes union and the entire union itself is optional, the docs do not emit correctly. Repro: https://stackblitz.com/edit/vitejs-vite-vyxrtv?file=src%2Findex.ts TypeDoc configuration export const handleArrayOfOptionalStuff = (
a: [(null | undefined | Stuff)?]
) => {};
|
Looks great in 4.3.1, thank you @tgreyuk! |
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
For a function that accepts an array of optional elements, the type of the element is not hyperlinked in the generated markdown doc.
For example, given:
The generated markdown will be:
Repro: https://stackblitz.com/edit/vitejs-vite-nypddu
Steps to Reproduce
npm run docs:md
Actual Result
Generated markdown "links" the type
Stuff
forhandleStuff
,handleOptionalStuff
,handleArrayOfStuff
but not forhandleArrayOfOptionalStuff
Additional Information
npm run docs:html
)TypeDoc configuration
typedoc: 0.26.11
typedoc-plugin-markdown: 4.2.10
typescript" 5.6.3
Expected behavior
The generated markdown should contain a hyperlink to
Stuff
:The text was updated successfully, but these errors were encountered: