{"repo":"jsh9/pydoclint","free":true,"listed":false,"github":"https://github.com/jsh9/pydoclint","clone":"git clone https://github.com/jsh9/pydoclint.git","description":"A very fast Python docstring linter","language":"Python","stars":220,"topics":["docstring","docstring-checker","flake8","flake8-extension","flake8-extensions","flake8-plugin","flake8-plugins","linter","documantation","documentation-tool"],"license":"MIT","category":"dev-tools","readme_excerpt":"pydoclint Pydoclint is a Python docstring linter to check whether a docstring's sections (arguments, returns, raises, ...) match the function signature or function implementation. It runs really fast. In fact, it can be thousands of times faster than darglint (or its maintained fork darglint2). Here is a comparison of linting time on some famous Python projects: pydoclint darglint ------------------------------------------------------------ --------- --------------------------------- numpy 2.0 sec 49 min 9 sec (1,475x slower) scikit-learn 2.4 sec 3 hr 5 min 33 sec (4,639x slower) Additionally, pydoclint can detect quite a few style violations that darglint cannot. Currently, pydoclint supports three docstring styles: numpy, Google, and Sphinx, with some minor style deviations. Another note: this linter and pydocstyle serves complementary purposes. It is recommended that you use both together. The full documentation of pydoclint (including this README) can be found here: https://jsh9.github.io/pydoclint The corresponding Github repository of pydoclint is: https://github.com/jsh9/pydoclint Table of Contents - 1. Installation - 2. Usage - 2.1. As a native command line tool - 2.2. As a flake8 plugin - 2.3. Native vs flake8 - 2.4. As a pre-commit hook - 2.4.1. Native mode - 2.4.2. As a flake8 plugin - 2.5. How to configure pydoclint - 2.6. How to ignore certain violations - 2.7. Additional tips, tricks, and pitfalls - 2.7.1. How to not document certain functions? - 2.7.2. How to g","default_branch":null,"files":null,"tree":[],"storefront":"/r/jsh9","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/jsh9/pydoclint/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}