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

Links for "Implementation of X.y" are missing sometimes #2233

Closed
RunDevelopment opened this issue Apr 10, 2023 · 1 comment
Closed

Links for "Implementation of X.y" are missing sometimes #2233

RunDevelopment opened this issue Apr 10, 2023 · 1 comment
Labels
bug Functionality does not match expectation
Milestone

Comments

@RunDevelopment
Copy link
Contributor

Search terms

Implementation of

Expected Behavior

The "Implementation of X.y" section should always link to both X and y.

image

Actual Behavior

If y and the implementation of y are not the same kind, then there will be no link.

Note: I have only tested with methods implementing a property, but I highly suspect that properties implementing a method will have the same issue. Another case that should be tested is accessors implementing methods.

In the following example, isFinal is declared as a property, but implemented as a method.

image
image

Steps to reproduce the bug

  1. Download https://github.com/RunDevelopment/refa
  2. npm ci
  3. npm i -d typedoc@0.24.1
  4. npm run build:docs
  5. Open docs/index.html

Or see the doc pages generated by 0.23.28: ENFA.Builder#isFinal and FABuilder#isFinal.

Environment

  • Typedoc version: 0.24.1 (or 0.23.x)
  • TypeScript version: 5.0.2
  • Node.js version: 16.13.0
  • OS: Win10

Additional context

It's import for typedoc to support both styles. Property style declarations in interfaces have slightly different semantics to method style declarations, so we sometimes must use property style to ensure correctness. For more info, see TypeScript ESLint's method-signature-style rule.

@RunDevelopment RunDevelopment added the bug Functionality does not match expectation label Apr 10, 2023
@Gerrit0 Gerrit0 added this to the v0.24.2 milestone Apr 15, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 15, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants