{"categories":[{"label":"Quality Assurance","url":"https://skillfed.io/packages/category/software-development-quality-assurance/2"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Darglint is a docstring linter that checks whether function and method docstrings match their actual implementation, supporting Google, Sphinx, and Numpy style formats.","skillfed_tags":["docstring-validation","code-quality","linting"],"use_cases":["Enforce that docstrings document all function parameters and return values before code review.","Catch outdated docstrings when function signatures change during refactoring.","Validate exception documentation matches the actual exceptions a function can raise.","Integrate into CI/CD pipelines to fail builds when docstrings drift from implementation.","Configure strictness levels to allow simple one-liners while fully checking complex functions."],"what_it_does":"Darglint is a linter that validates whether docstrings accurately describe the functions and methods they document. It parses docstrings in Google, Sphinx, or Numpy style and compares them against the actual code\u2014checking that documented parameters, return types, exceptions, and yields match what the implementation actually does. The tool runs from the command line and can be configured to ignore specific errors, adjust strictness levels (short/long/full), and customize error message formats.\n\nThe project is currently in maintenance mode: the original maintainer no longer works with Python regularly and is not adding significant new features, though bug fixes and pull requests are still accepted. It has no runtime dependencies, making installation straightforward. The tool is useful for teams that want to enforce documentation accuracy as part of their code quality pipeline, though ongoing maintenance and feature development should not be expected.","worth_installing":"Yes, if you need docstring validation and accept maintenance-mode status. The tool is stable, has no dependencies, and works reliably for its core purpose. Install it if your team uses Google, Sphinx, or Numpy docstring styles and wants automated checks for documentation accuracy. Do not expect new features or rapid bug fixes; evaluate whether the current feature set meets your needs before adopting."},"id":"darglint","links":{"html":"https://skillfed.io/packages/darglint","md":"https://skillfed.io/packages/darglint.md","pypi":"https://pypi.org/project/darglint/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2021-10-18","license_spdx":null,"license_treatment":"permissive","name":"darglint","python_support":"supports_current","summary":"A utility for ensuring Google-style docstrings stay up to date with the source code."},"popularity":{"monthly_downloads":570518,"position":5955,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.8.1"}