pydoctest
Python docstring signature verification (by jepperaskdk)
darglint
A python documentation linter which checks that the docstring description matches the definition. (by terrencepreilly)
| pydoctest | darglint | |
|---|---|---|
| 1 | 2 | |
| 18 | 464 | |
| - | - | |
| 1.7 | 10.0 | |
| about 1 year ago | over 1 year ago | |
| Python | Python | |
| MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
pydoctest
Posts with mentions or reviews of pydoctest.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-02-14.
-
Ruff: An fast Python linter, written in Rust
Tangential, but do any python users have a tool they like for testing that fully-formed doc comments (e.g. Google or numpy style) are correct, meaning the arg names and types reflect the function signature?
Pydocstyle, pylint, and ruff will all check for some amount of presence and format, but if a type is wrong or an arg missing, you're on your own, AFAICT.
I found pydoctest¹, but it looks somewhat unmaintained, and bugs like "doesn't work with relative imports" makes me hesitant to use it.
¹https://github.com/jepperaskdk/pydoctest
darglint
Posts with mentions or reviews of darglint.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-02-14.
-
Ruff: An fast Python linter, written in Rust
I've never used, but have heard good things about darglint (although it's now archived): https://github.com/terrencepreilly/darglint
A lot of folks want us to add that kind of enforcement to Ruff (https://github.com/charliermarsh/ruff/issues/458), and I want to do it, but it's a big project and some other stuff has higher priority :)
-
Why Type Hinting Sucks!
That's what tools like darglint are for (yes, I'm aware darglint was recently moved to maintenance mode).
What are some alternatives?
When comparing pydoctest and darglint you can also consider the following projects:
ruff - An extremely fast Python linter and code formatter, written in Rust.