docsig
Check signature params for proper documentation
Decision gist · record as of 2026-08-14
Yes. Docsig fills a real gap in Python documentation tooling—it's actively maintained, has zero known vulnerabilities, installs with low friction, and supports multiple docstring formats and integration points. Use it if you want to enforce documentation accuracy for function signatures as part of your development workflow or CI pipeline.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Low friction installation with a pure-Python wheel.
- Active maintenance—released 6 days ago—and actively maintained dependencies (astroid, pathspec, tomli, wcmatch) with no known vulnerabilities.
License · maintenance · safety
MIT (permissive) — MIT license permits unrestricted use, modification, and distribution in both open-source and proprietary projects with minimal obligations.
last release 2026-08-08 (6 days) · last repo commit 2026-08-10 · 44 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 431,177 downloads/mo, #6,720 on PyPI
Alternatives
Verify before relying
pip install docsig
from docsig import docsig
code = '''
def func(a, b):
"""Summary.
:param a: Description.
:param b: Description.
"""
'''
result = docsig(string=code, no_ansi=True)
print(result) # 0 if valid, error count otherwise- Whether flake8 and pre-commit integrations work out-of-the-box or require additional setup beyond installation.
- Performance characteristics when linting large codebases or deeply nested function structures.
- Exact behavior of the PyCharm, VS Code, and Neovim plugins and whether they require separate installation.
What it is and what it does
Docsig is a documentation linter that automatically checks whether function and method parameters in Python code are properly documented in their docstrings. It parses function signatures and compares them against docstring documentation in reStructuredText (Sphinx), NumPy, and Google formats, flagging mismatches such as missing parameter documentation, documented parameters that don't exist in the signature, or undocumented parameters.
It runs as a standalone command-line tool, integrates with flake8 as a plugin, works as a pre-commit hook, and has IDE plugins for PyCharm, VS Code, and Neovim. Configuration is managed via command-line flags, pyproject.toml, or flake8 config files. The tool supports granular control over what to check—classes, dunder methods, nested functions, overridden methods, protected members—and which checks to disable or target.
Use it for
- Enforce consistent docstring documentation standards in CI/CD pipelines via pre-commit hooks or flake8 integration.
- Catch documentation drift during code review by running docsig on pull requests to flag signature-docstring mismatches.
- Validate that all public API parameters are documented before release, reducing user-facing documentation gaps.
- Integrate into IDE workflows (PyCharm, VS Code, Neovim) to catch documentation issues in real-time during development.
- Audit existing codebases to identify undocumented or incorrectly documented function parameters at scale.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Docsig fills a real gap in Python documentation tooling—it's actively maintained, has zero known vulnerabilities, installs with low friction, and supports multiple docstring formats and integration points. Use it if you want to enforce documentation accuracy for function signatures as part of your development workflow or CI pipeline.
Install
docsig on PyPI
Before you install
Low friction installation with a pure-Python wheel. Active maintenance—released 6 days ago—and actively maintained dependencies (astroid, pathspec, tomli, wcmatch) with no known vulnerabilities.
Requires Python 3.10 or later.
License in practice
MIT license permits unrestricted use, modification, and distribution in both open-source and proprietary projects with minimal obligations.
Quickstart
pip install docsig
from docsig import docsig
code = '''
def func(a, b):
"""Summary.
:param a: Description.
:param b: Description.
"""
'''
result = docsig(string=code, no_ansi=True)
print(result) # 0 if valid, error count otherwiseVerify before relying
- Whether flake8 and pre-commit integrations work out-of-the-box or require additional setup beyond installation.
- Performance characteristics when linting large codebases or deeply nested function structures.
- Exact behavior of the PyCharm, VS Code, and Neovim plugins and whether they require separate installation.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesastroidpathspectomliwcmatch |
| Maintenance | Actively maintained 6 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 431,177 / month, #6,720 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Programming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14 |
Evidence: docsig-0.94.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “docstring parameter linter”
- docsigLints Python function and method signatures to ensure their…
- docstring-parserParses Python docstrings in ReST, Google, Numpydoc, and Epydoc…
- pydoclintPydoclint is a Python docstring linter that validates whether…
Give your agent the search over MCP, or paste the wish link into any chat.
More Quality Assurance packages
Coverage.py measures which lines of Python code are executed during test runs, reporting coverage percentages and identifying untested code paths.
Install it if you want to measure test completeness or enforce coverage thresholds in your project.
Ruff is a Python linter and code formatter written in Rust that combines linting, formatting, and code fixing into a single tool, replacing Flake8, Black, isort, and related utilities.
Pexpect spawns and controls interactive console applications by sending input and matching output patterns, automating tasks that would otherwise require manual interaction.
Black reformats Python source code to a consistent style by parsing entire files and rewriting them according to an opinionated, deterministic set of rules, eliminating manual formatting decisions.
pytest-xdist distributes pytest tests across multiple CPU cores or machines to speed up test execution, with the simplest usage being `pytest -n auto` to spawn workers equal to available CPUs.
Install it if your test suite takes long enough that parallelization would save meaningful time.
Validates AWS CloudFormation templates in YAML or JSON format against resource provider schemas and best practices, checking property values and configuration correctness.
Install it if you work with CloudFormation templates.
See also sphinx-lint · darglint · funcsigs · overrides · pydoclint · docstring-parser-fork · flake8-rst-docstrings · docstring-parser · yamllint · rstcheck