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

Duplicate comment in interfaces and types #2509

Closed
Kartanovicius opened this issue Feb 28, 2024 · 3 comments
Closed

Duplicate comment in interfaces and types #2509

Kartanovicius opened this issue Feb 28, 2024 · 3 comments
Labels
bug Functionality does not match expectation

Comments

@Kartanovicius
Copy link

Kartanovicius commented Feb 28, 2024

Search terms

tsd-parameters
tsd-comment
duplicate comments
interface comments duplicate
types comments duplicate

Expected Behavior

Interface and types should not duplicate comments

Actual Behavior

Duplicates comments in interface and types

Before 0.25.5
image

After 0.25.5
image

Steps to reproduce the bug

Duplicates are appearing only in interfaces and types after typedoc upgrade to 0.25.5

UPDATE 2024-02-29
Created repository that can easily reproduce bug. https://github.com/Kartanovicius/test-rep

Environment

  • Typedoc version: 0.25.5
  • TypeScript version: 5.3.3
  • Node.js version: 18
  • OS: Any
@Kartanovicius Kartanovicius added the bug Functionality does not match expectation label Feb 28, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 29, 2024

Please provide a minimal reproduction. I can't run typedoc on Screenshots.

@Gerrit0 Gerrit0 added the needs reproduction Needs a minimal reproducible case label Feb 29, 2024
@Kartanovicius
Copy link
Author

@Gerrit0 Gerrit0 removed the needs reproduction Needs a minimal reproducible case label Mar 3, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 3, 2024

Caused by 03426c3, I handled signature checking one level deep, but didn't correctly handle comments attached to a type property on a reflection.

More minimal:

export interface InterceptorMethodAPI {
    /**
     * Duplicated
     */
    callback: () => Promise<any>;
}

@Gerrit0 Gerrit0 closed this as completed in 657045c Mar 3, 2024
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