docsig

0.83.0 verified Mon Apr 27 auth: no python

A static analysis tool that checks function signature parameters are properly documented in docstrings. Supports Google, NumPy, Sphinx, and reStructuredText styles. Current version 0.83.0, released 2026-04-18. Active development with regular releases.

pip install docsig

Common errors

error ImportError: cannot import name 'check_signatures' from 'docsig' ↓

cause check_signatures is not a public API; it's in docsig._impl.

fix

Use from docsig._impl import check_signatures instead.

error AttributeError: module 'docsig' has no attribute 'run' ↓

cause Programmatic API changed; run() was removed in v0.80+.

fix

Use from docsig import main and invoke via command-line arguments.

error RuntimeError: This event loop is already running ↓

cause When using docsig in a context with an existing event loop (e.g. Jupyter).

fix

Call main() with loop=asyncio.new_event_loop() or use docsig.check_signatures directly with synchronous wrappers.

Warnings

breaking From v0.80.0, the `--ignore-typechecker` option was deprecated and may be removed in future. Use `--skip-typechecker` instead. ↓

fix Replace `--ignore-typechecker` with `--skip-typechecker` in CLI or config.

deprecated In v0.81.0, a future warning for missing period in description was added. Enable it with `--future-description-missing-period`. ↓

fix Add `--future-description-missing-period` to CLI to see warnings.

gotcha Direct import of `check_signatures` from `docsig` is not exposed; it lives in `docsig._impl`. Using `from docsig import check_signatures` will raise ImportError. ↓

fix Use `from docsig._impl import check_signatures` or use the `main()` entry point.

gotcha docsig only supports Python >=3.10. Using on older Python versions will fail at installation. ↓

fix Upgrade to Python 3.10+ or use an older version of docsig (0.79.x supports 3.8+).

Imports

main
```
from docsig import main
```
Entry point for programmatic use

check_signatures

wrong

from docsig import check_signatures

correct

from docsig._impl import check_signatures

check_signatures is in private module as of 0.80+

Quickstart

Programmatic invocation: emulate CLI args and call main()

from docsig import main
import sys
sys.argv = ['docsig', '--help']
try:
    main()
except SystemExit:
    pass