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

Re-exported individual named modules don't show up #2811

Closed
aayla-secura opened this issue Dec 14, 2024 · 3 comments
Closed

Re-exported individual named modules don't show up #2811

aayla-secura opened this issue Dec 14, 2024 · 3 comments
Labels
bug Functionality does not match expectation

Comments

@aayla-secura
Copy link

Search terms

re-export

Question

Not sure if that's a bug, or I'm misunderstanding something.

If a module re-exports everything from another using export * from "some-module", then all of some-module's exports will show as re-exports in the doc for that module. However if I do export { something } from "some-module", nothing shows up. Why is that? How can I include in the doc a particular named re-export?

@aayla-secura aayla-secura added the question Question about functionality label Dec 14, 2024
Gerrit0 added a commit to TypeStrong/typedoc-repros that referenced this issue Dec 14, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 14, 2024

If that's the case, it sounds like a possible bug, however a quick attempt at reproducing it does not show this issue. TypeStrong/typedoc-repros#46, something shows up in the docs.

If some-module is within node_modules, it is likely being picked up as external, and it might be hidden by default by the visiblityFilters checkboxes in settings.

@aayla-secura
Copy link
Author

Ok, this was kind of hard to reproduce with a minimal example. It's quite bizarre. I created an example that shows this and a short explanation: TypeStrong/typedoc-repros#47

I hope this helps. I think it should be marked as a bug.

@Gerrit0 Gerrit0 added bug Functionality does not match expectation and removed question Question about functionality labels Dec 18, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 18, 2024

Perfect, thanks! That is a strange one.

What's happening here is that TypeDoc creates a reference in index which points to the reference in index-debug, which gets removed by @hidden so TypeDoc cleans up references to that reference. Easy enough fix, just have to make TypeDoc not make chains of references, and always point at the eventual target. Not sure why it didn't always work like this...

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