[Bug] D100: Module Containing Single Leading Underscore Considered Public

[gbroques]

Issue: Receive "D100: Missing docstring in public module" error for module containing single leading underscore.

pydocstyle version: 5.0.2
python version: 3.8.4

From How publicity is determined:

Publicity for all constructs is determined as follows: a construct is considered public if -

• Its immediate parent is public and
• Its name does not contain a single leading underscore.

How to Reproduce

Consider the following simple example.

publicpackage/
├── __init__.py
└── _privatemodule.py  # D100: Missing docstring in public module

Within publicpackage/__init__.py:

"""Some docstring."""
from ._privatemodule import public_function_in_private_module

__all__ = ['public_function_in_private_module']

Within publicpackage/_privatemodule.py:

def public_function_in_private_module():
    """Public function in private module docstring."""
    pass

$ pydocstyle publicpackage      
publicpackage/_privatemodule.py:1 at module level:
        D100: Missing docstring in public module

Expected Behavior

_privatemodule contains single leading underscore, and would be considered private, not public.

Related Issues

• [D100 claims module is public when it is prefixed _ #199] D100 claims module is public when it is prefixed _
• [Publicity and privacy derived from modules seems wrong #323] Publicity and privacy derived from modules seems wrong

[samj1912]

related pr #470

[gbroques]

related pr #470

@samj1912 Opened #494 as a continuation of work in #470.

[FrancescoCasalegno]

I just had the same error.

[samj1912]

Closed via #494