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.

Sign up for GitHub

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

Jump to bottom

Classes in documentation show "default" instead of their intended class names #160

Closed
danbopes opened this issue Feb 4, 2022 · 2 comments · Fixed by #166
Closed

Classes in documentation show "default" instead of their intended class names #160

danbopes opened this issue Feb 4, 2022 · 2 comments · Fixed by #166
Assignees
@Oaphi
Labels
bug Something isn't working

Comments

@danbopes
Copy link
Collaborator

danbopes commented Feb 4, 2022

See https://samliew.github.io/chatexchange/classes/Message.default.html:

This function should return Promise<User> but instead shows Promise<default> (This happens frequently throughout the docs).

Would be nice to show the actual class names instead of default. (Probably some ES6 thing with the default export).
@Oaphi Oaphi added the bug Something isn't working label Mar 4, 2022
@Oaphi Oaphi self-assigned this Mar 4, 2022
@Oaphi
Copy link
Collaborator

Oaphi commented Mar 5, 2022 •
edited
Loading

This issue on the typedoc source repo seems relevant: TypeStrong/typedoc/issues/1521. Seems like a change introduced around 0.20 version of typedoc, and the core contributor has a strong opinion about it. Since there exists a plugin now, I think we can use it, let me throw together a quick PR.

@Oaphi
Copy link
Collaborator

Oaphi commented Mar 5, 2022

Perfect fix, a PR coming right up:

ice_screenshot_20220305-034416

Oaphi added a commit that referenced this issue Mar 5, 2022
@Oaphi
added plugin for returning names to default exports in generated docs; …
03a3b7c 
…fixes #160
@Oaphi Oaphi mentioned this issue Mar 5, 2022
Merged
@Oaphi Oaphi linked a pull request Mar 5, 2022 that will close this issue
Fix for default exports losing their names in generated docs #166
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Oaphi Oaphi

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix for default exports losing their names in generated docs samliew/chatexchange
2 participants
@danbopes @Oaphi