{"id":21176,"library":"docsig","title":"docsig","description":"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.","status":"active","version":"0.83.0","language":"python","source_language":"en","source_url":"https://github.com/jshwi/docsig","tags":["docstrings","linting","static-analysis"],"install":[{"cmd":"pip install docsig","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"Entry point for programmatic use","symbol":"main","correct":"from docsig import main"},{"note":"check_signatures is in private module as of 0.80+","wrong":"from docsig import check_signatures","symbol":"check_signatures","correct":"from docsig._impl import check_signatures"}],"quickstart":{"code":"from docsig import main\nimport sys\nsys.argv = ['docsig', '--help']\ntry:\n    main()\nexcept SystemExit:\n    pass","lang":"python","description":"Programmatic invocation: emulate CLI args and call main()"},"warnings":[{"fix":"Replace `--ignore-typechecker` with `--skip-typechecker` in CLI or config.","message":"From v0.80.0, the `--ignore-typechecker` option was deprecated and may be removed in future. Use `--skip-typechecker` instead.","severity":"breaking","affected_versions":">=0.80.0"},{"fix":"Add `--future-description-missing-period` to CLI to see warnings.","message":"In v0.81.0, a future warning for missing period in description was added. Enable it with `--future-description-missing-period`.","severity":"deprecated","affected_versions":">=0.81.0"},{"fix":"Use `from docsig._impl import check_signatures` or use the `main()` entry point.","message":"Direct import of `check_signatures` from `docsig` is not exposed; it lives in `docsig._impl`. Using `from docsig import check_signatures` will raise ImportError.","severity":"gotcha","affected_versions":">=0.80.0"},{"fix":"Upgrade to Python 3.10+ or use an older version of docsig (0.79.x supports 3.8+).","message":"docsig only supports Python >=3.10. Using on older Python versions will fail at installation.","severity":"gotcha","affected_versions":">=0.80.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Use `from docsig._impl import check_signatures` instead.","cause":"check_signatures is not a public API; it's in docsig._impl.","error":"ImportError: cannot import name 'check_signatures' from 'docsig'"},{"fix":"Use `from docsig import main` and invoke via command-line arguments.","cause":"Programmatic API changed; run() was removed in v0.80+.","error":"AttributeError: module 'docsig' has no attribute 'run'"},{"fix":"Call `main()` with `loop=asyncio.new_event_loop()` or use `docsig.check_signatures` directly with synchronous wrappers.","cause":"When using docsig in a context with an existing event loop (e.g. Jupyter).","error":"RuntimeError: This event loop is already running"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}