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

Empty modules with only top-level docstring are not included #1948

Closed
letmaik opened this issue Jun 1, 2022 · 1 comment
Closed

Empty modules with only top-level docstring are not included #1948

letmaik opened this issue Jun 1, 2022 · 1 comment
Labels
bug Functionality does not match expectation
Milestone

Comments

@letmaik
Copy link

letmaik commented Jun 1, 2022

The change was introduced with #1607.
Previous to that, a module that a had a docstring with @module was included but now it is excluded.
The module is part of "entryPoints" in typedoc.json.

Being able to include those "empty" module is useful if they exist for their side-effects only, like polyfills.

To reproduce, here is the module that is not rendered:
https://github.com/microsoft/CCF/blob/b1cdae40ba927e45fe8178791fa6e509b3a09097/js/ccf-app/src/polyfill.ts

and the corresponding config:
https://github.com/microsoft/CCF/blob/b1cdae40ba927e45fe8178791fa6e509b3a09097/js/ccf-app/typedoc.json

Short of adding a dummy symbol, is there a way to tell typedoc to include such modules?

@letmaik letmaik added the bug Functionality does not match expectation label Jun 1, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 3, 2022

Looking at that again, I don't much like the change... TypeDoc shouldn't ignore entry points because they're empty. The excludeNotDocumented use case should be handled by checking that a module is not documented and contains no children.

@Gerrit0 Gerrit0 added this to To do in TSDoc - v0.23 via automation Jun 3, 2022
@Gerrit0 Gerrit0 added this to the v0.23 milestone Jun 3, 2022
@Gerrit0 Gerrit0 moved this from To do to In progress in TSDoc - v0.23 Jun 4, 2022
@Gerrit0 Gerrit0 moved this from In progress to Done in TSDoc - v0.23 Jun 4, 2022
@Gerrit0 Gerrit0 mentioned this issue Jun 4, 2022
8 tasks
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
No open projects
Development

No branches or pull requests

2 participants