{"library":"pydoclint","title":"PyDocLint","description":"PyDocLint is a fast Python docstring linter that verifies whether a function's docstring sections (arguments, returns, yields, and raises) accurately match its signature and implementation. It currently supports NumPy, Google, and Sphinx docstring styles, running significantly faster than older alternatives. The library is actively maintained with frequent releases, and its current version is 0.8.3.","language":"python","status":"active","last_verified":"Wed Apr 15","install":{"commands":["pip install pydoclint","pip install pydoclint[flake8]"],"cli":{"name":"pydoclint","version":"pydoclint, version 0.8.3"}},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"# my_module.py\ndef my_function(arg1: int, arg2: str) -> None:\n    \"\"\"\n    A sample function.\n\n    Parameters\n    ----------\n    arg1 : int\n        The first argument.\n    arg2 : str\n        The second argument.\n    \"\"\"\n    print(f'{arg1}, {arg2}')\n\n# pyproject.toml\n[tool.pydoclint]\nstyle = \"numpy\"\ncheck-arg-order = true\n\n# Terminal\n# Run pydoclint on a file or folder\npydoclint my_module.py\n# Or with a config file\npydoclint --config=pyproject.toml my_module.py\n# Or as a pre-commit hook (add to .pre-commit-config.yaml)\n# - repo: https://github.com/jsh9/pydoclint\n#   rev: <latest_tag> # e.g., 0.8.3\n#   hooks:\n#     - id: pydoclint\n#       args: [\"--config=pyproject.toml\"]","lang":"python","description":"To get started, install pydoclint and run it as a command-line tool on your Python files or directories. Configuration can be managed via a `pyproject.toml` file or command-line arguments.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}