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 #2007

Closed
eddyashton opened this issue Jul 18, 2022 · 1 comment
Closed

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

eddyashton opened this issue Jul 18, 2022 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@eddyashton
Copy link

Re-opening #1948, as our empty module is still not documented after 7918fba.

After examining the proposed fix in v0.23 and our module, it looks like the difference is that your test case has an export, while our module has no exports. So this block does an early out:

        if (allExports.every((exp) => this.shouldIgnore(exp))) {
            this.owner.logger.verbose(`All members of ${entryName} are excluded, ignoring entry point.`);
            return;
        }

And sure enough we see that with verbose logging:

All members of polyfill are excluded, ignoring entry point.

An empty module with no exports, but a @module docstring, should be included, as it was before #1607.

@eddyashton eddyashton added the bug Functionality does not match expectation label Jul 18, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 19, 2022

Hmmm.... this if was apparently added to fix the original bug with empty modules due to excludeNotDocumented. I guess it's probably okay to remove it...

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