{"categories":[{"label":"Quality Assurance","url":"https://skillfed.io/packages/category/software-development-quality-assurance"}],"enrichment":{"capability":"Integrates pydocstyle docstring checking into flake8, allowing you to enforce docstring conventions (PEP 257, numpy, google, or custom) as part of your flake8 linting workflow.","skillfed_tags":["linting","docstring-validation","flake8-plugin"],"use_cases":["Enforce numpy-style docstrings in scientific Python projects as part of CI/CD linting.","Add docstring validation to an existing flake8 setup without changing your workflow.","Enforce google-style docstrings in projects that prefer that convention over PEP 257.","Selectively check specific docstring error codes using flake8's --select flag.","Maintain consistent docstring standards across a team by centralizing the rule in flake8 config."],"what_it_does":"flake8-docstrings is a flake8 plugin that brings pydocstyle's docstring validation into the flake8 linting ecosystem. Instead of running pydocstyle separately, you configure it once in your flake8 setup and check docstrings alongside your other code quality rules. It supports multiple docstring conventions\u2014PEP 257 (the default), numpy, and google\u2014and lets you pick which error codes to enforce using flake8's standard --ignore and --select flags.\n\nThe package is lightweight and straightforward to integrate: install it, add a configuration line to your flake8 config (or pass --docstring-convention at the command line), and run flake8 as usual. It's useful for teams that want unified linting configuration and developers who prefer a single tool for all style checks rather than managing separate linters.","worth_installing":"Yes. This is a stable, actively maintained plugin with low install friction and no known vulnerabilities. Install it if you use flake8 and want to enforce docstring conventions without adding a separate linting tool to your workflow. The only caveat is that it hasn't been updated since January 2023, so verify compatibility with your current flake8 and pydocstyle versions before relying on it in new projects."},"id":"flake8-docstrings","links":{"html":"https://skillfed.io/packages/flake8-docstrings","md":"https://skillfed.io/packages/flake8-docstrings.md","pypi":"https://pypi.org/project/flake8-docstrings/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2023-01-25","license_spdx":null,"license_treatment":"permissive","name":"flake8-docstrings","python_support":"supports_current","summary":"Extension for flake8 which uses pydocstyle to check docstrings"},"popularity":{"monthly_downloads":2053070,"position":3337,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"1.7.0"}