{"categories":[{"label":"Quality Assurance","url":"https://skillfed.io/packages/category/software-development-quality-assurance/2"}],"enrichment":{"capability":"Lints Python function and method signatures to ensure their parameters are properly documented in docstrings, supporting reStructuredText, NumPy, and Google styles.","skillfed_tags":["docstring-linting","code-quality","documentation-tools"],"use_cases":["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."],"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.\n\nIt 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\u2014classes, dunder methods, nested functions, overridden methods, protected members\u2014and which checks to disable or target.","worth_installing":"Yes. Docsig fills a real gap in Python documentation tooling\u2014it'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."},"id":"docsig","links":{"html":"https://skillfed.io/packages/docsig","md":"https://skillfed.io/packages/docsig.md","pypi":"https://pypi.org/project/docsig/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-08-08","license_spdx":"MIT","license_treatment":"permissive","name":"docsig","python_support":"supports_current","summary":"Check signature params for proper documentation"},"popularity":{"monthly_downloads":431177,"position":6720,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.94.0"}