docsig

library0.87.1pypypi✓ verified 86d ago

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.

testing

pip install docsig

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · DOCSIG

docsig

testingpythonv0.87.1

Install

2.9s avg

Import

403ms

Disk

35MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.87.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.422s · 21.8MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 2.9s · import 0.384s · 22MB

35MB installed

● package 35MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

main

✓ from docsig import main

Entry point for programmatic use

check_signatures

✓ from docsig._impl import check_signatures

✗ from docsig import check_signatures

check_signatures is in private module as of 0.80+

Programmatic invocation: emulate CLI args and call main()

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

docsig --version

Debug

Known issues

breakingFrom 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.

affects: >=0.80.0

deprecatedIn 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.

affects: >=0.81.0

gotchaDirect 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.

affects: >=0.80.0

gotchadocsig 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+).

affects: >=0.80.0

Errors

Common errors & fixes

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

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

fix

Use `from docsig._impl import check_signatures` instead.

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

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

fix

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

RuntimeError: This event loop is already running

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.

Upgrade

Version history

0.87.1latest on PyPI · released Jun 13, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

11 hits · last 30 days

node

Resources

githubhttps://github.com/jshwi/docsig ↗

packagehttps://pypi.org/project/docsig/ ↗

homepagehttps://docsig.io ↗

docshttps://docsig.io/en/latest ↗