@link syntax eats hyphen

[jrieken]

TS Template added by @mjbvz

TypeScript Version: 4.7.0-dev.20220323

Search Terms

• jsdoc
• quickinfo

---

• hover over this doc: https://github.com/microsoft/vscode/blob/9d2324412916035d7a955150ac1774d5b25e265a/src/vscode-dts/vscode.proposed.notebookDocumentEvents.d.ts#L25
• the - isn't rendered...

[mjbvz]

Looks like a recent regression. Works for me with TS 4.6.2 but not with the latest TS 4.7 nightly

[mjbvz]

Self contained example:

/**
 * {@link bar}-thing
 */
function bar() {}

[a-tarasyuk]

Omitting - separator was introduced in #44956. {@link bar}-thing parsed as [JSDocText, JSDocLink, JSDocText], the last comment contains text -thing which stars with - separator. Maybe this should be applied only to the @ param tag or completely reverted.

[DanielRosenwasser]

I think scoping it to just the @param tag is reasonable, but I'm open to suggestions/thoughts from others

[sandersn]

My personal preference would be to revert entirely, but you could also argue that @param {type} name - description is a common pattern, and only remove the dash right after the parameter name of a @param tag.

I personally like to see the dash in that case, but the person who filed the original bug did not.