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

"Implementation of X.y" does not work correctly for Iterable<T> #2234

Closed
RunDevelopment opened this issue Apr 10, 2023 · 2 comments
Closed
Labels
bug Functionality does not match expectation
Milestone

Comments

@RunDevelopment
Copy link
Contributor

RunDevelopment commented Apr 10, 2023

Search terms

iterable, implementation of

Expected Behavior

When a class implements an interface Foo that extends Iterable<T>, then the class method should have a note: "Implementation of "Implementation of Foo.[iterator]" or "Foo[iterator]".

Actual Behavior

image

This is likely caused by typedoc not generating an inherited method for ReadonlyCharMap[iterator].

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: CharMap[iterator]

Environment

  • Typedoc version: 0.24.1 (or 0.23.x)
  • TypeScript version: 5.0.2
  • Node.js version: 16.13.0
  • OS: Win10
@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

This is mostly working as intended. ReadonlyCharMap doesn't get an [iterator] property because it is considered external as all declarations are in node_modules and TypeDoc is configured to exclude externals.

TypeDoc should be resolving __@iterator to [iterator] though in the excluded externals case, so that needs to be fixed.

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