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

Link is generated for external symbol if set to link to "#" in externalSymbolLinkMappings #2921

Closed
dev7355608 opened this issue Mar 27, 2025 · 2 comments

Comments

@dev7355608
Copy link

Search terms

externalSymbolLinkMappings

Expected Behavior

https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings:

The string "#" may also be specified to indicate to TypeDoc that the type should be marked as resolved but no link should be created.

No link is generated if link is set of "#" in externalSymbolLinkMappings.

Actual Behavior

A link is generated.

<a href="#">!Promise</a>

Steps to reproduce the bug

// typedoc.json
{
    "externalSymbolLinkMappings": {
        // used by {@link !Promise}
        "global": {
            "Promise": "#"
        }
    }
}

Environment

  • Typedoc version: 0.27.9
  • TypeScript version:
  • Node.js version: v22.12.0
  • OS: Windows 11
Gerrit0 added a commit that referenced this issue Apr 1, 2025
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 1, 2025

This may be an issue with an older version, but does not reproduce with the latest version, I just added a test 963e9c9 which demonstrates it working correctly.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 3, 2025

... I just double checked rendering fully to HTML rather than the JSON snapshot, and do still see this issue

@Gerrit0 Gerrit0 closed this as completed in a4b022e Apr 3, 2025
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