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

Missing comments on interface index signatures #2414

Closed
adidahiya opened this issue Oct 20, 2023 · 2 comments
Closed

Missing comments on interface index signatures #2414

adidahiya opened this issue Oct 20, 2023 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@adidahiya
Copy link
Contributor

Search terms

missing, omitted, comment, property, method, interface, signature

Actual Behavior

I'm working on upgrading a library from typedoc 0.19 -> 0.25 and I'm noticing that comments on index signatures are being dropped:

export interface ObjectWithIndexSignature {
  /** Looking for this JSDoc comment in the output JSON. */
  [x: string]: any;
}

The reflection for the index signature both return ref.hasComment() == false and I no longer get the comment contents.

You can see my Jest snapshots which changed to flag this regression in my upgrade PR here: palantir/documentalist#156 (comment)

Expected Behavior

I should get comments on index signatures like I previously did with typedoc v0.19

Steps to reproduce the bug

See repro on my fork here: adidahiya/typedoc-repros#1

Environment

  • Typedoc version: 0.25.2
  • TypeScript version: 5.2.2
  • Node.js version: 18.18
  • OS: macOS
@adidahiya adidahiya added the bug Functionality does not match expectation label Oct 20, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 21, 2023

Good find!

@adidahiya
Copy link
Contributor Author

nice, thanks for the quick fix @Gerrit0!

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