lang-python

Python public API surface detection works by analyzing __all__ declarations and applying naming conventions to determine module-level visibility. It identifies exposed functions, classes, methods, constants, and type aliases while filtering out internal members.

To check Python docstrings for missing parameter and return descriptions, parse Google, NumPy, or Sphinx formats to extract documentation expectations. The analysis highlights missing parameter and return descriptions and verifies alignment with code.

The best way to enforce documentation conventions across Python modules is to apply code analysis that extracts documentation expectations from Google, NumPy, and Sphinx formats. This provides structured results highlighting missing docstrings and verifying alignment with code.

Yes, public API detection respects __all__ declarations in Python. If __all__ is present, the analysis uses it to determine module-level visibility; otherwise, it filters out internal members based on standard naming conventions.

Yes, you can extract type aliases and constants as part of a Python public API surface. The detection applies across functions, classes, methods, constants, and type aliases to comprehensively determine module-level visibility.

Python docstrings are flagged as incomplete when using Sphinx format if the analysis detects missing parameter or return descriptions, or finds misalignment between the documented expectations and the actual code signature.