pydocstyle vs pyment

pydocstyle

docstring style checker (by PyCQA)

DISCONTINUED

Suggest alternative

Edit details

pyment

Format and convert Python docstrings and generates patches (by dadadel)

Python Docstrings Documentation Numpy Google Development developer-tools epydoc

Source Code

Suggest alternative

Edit details

Our great sponsors

WorkOS - The modern identity platform for B2B SaaS

InfluxDB - Power Real-Time Data Analytics at Scale

SaaSHub - Software Alternatives and Reviews

Our great sponsors

pydocstyle		pyment
	Project
4	Mentions	2
1,106	Stars	876
-	Growth	-
6.1	Activity	1.9
6 months ago	Latest Commit	about 2 months ago
Python	Language	Python
MIT License	License	GNU General Public License v3.0 only

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.

pydocstyle

Posts with mentions or reviews of pydocstyle. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2022-06-13.

Best general packages to use for Python projects
6 projects | /r/Python | 13 Jun 2022

Not so much for the project but for project support I always use black for formatting. mypy to check my code. pydocstyle to check the comments.
What do you think about this method docstring style?
2 projects | /r/Python | 9 Jan 2022

Check out https://github.com/pycqa/pydocstyle. There's a flake8 extension for it too https://pypi.org/project/flake8-docstrings/
Code Quality Tools in Python
9 projects | dev.to | 9 Oct 2021

pydocstyle
What's your 5(ish) year career plan?
1 project | /r/networking | 5 Jul 2021

something like pydocstyle and make sure all your functions and classes are correctly documented.

pyment

Posts with mentions or reviews of pyment. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2022-03-31.

[Python] No docstring formatters?
2 projects | /r/vscode | 31 Mar 2022

I can't find any decent automatic docstring formatter. The only two I stumble upon so far are docformatter and pyment, but none of them wraps long lines. I heard PyCharm has a formatter, but I would rather stick with VSCode.
Change docstring style for a project's entire codebase
1 project | /r/pycharm | 17 May 2021

Ah - I was thrown off by 'type' vs 'style'. You might want to take a look at https://github.com/dadadel/pyment

What are some alternatives?

When comparing pydocstyle and pyment you can also consider the following projects:

mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.

pdoc - API Documentation for Python Projects

black - The uncompromising Python code formatter

autopep8 - A tool that automatically formats Python code to conform to the PEP 8 style guide.

docformatter - Formats docstrings to follow PEP 257

pycodestyle - Simple Python style checker in one Python file

httpie - 🥧 HTTPie CLI — modern, user-friendly command-line HTTP client for the API era. JSON support, colors, sessions, downloads, plugins & more.

pylama - Code audit tool for python.

reloadr - Hot code reloading tool for Python

pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.

documented - Templated docstrings for Python classes