Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit 8d0cdfc

Browse files
authored
Deprecate pydocstyle in favor of ruff (#658)
Over the last couple of years, I have been the sole maintainer of pydocstyle. During the last year, we made a call for maintainers but we're unsuccessful in finding appropriate maintainers. Given the emergence of ruff and it's features, it's hard to justify the continued maintenance of pydocstyle. After a conversation with @Nurdok we both agree it's time to archive the project in favor of ruff.
1 parent f78f194 commit 8d0cdfc

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
11
pydocstyle - docstring style checker
22
====================================
33

4+
======================================
5+
Deprecation Notice: Pydocstyle
6+
======================================
7+
8+
.. IMPORTANT: Deprecation Notice
9+
:style: alert
10+
11+
.. image:: https://img.shields.io/badge/deprecated-red
12+
:target: https://github.com/PyCQA/pydocstyle
13+
:alt: Deprecated
14+
15+
The Pydocstyle project is officially deprecated, and it is no longer actively maintained.
16+
17+
18+
19+
Ruff: A Modern Alternative
20+
--------------------------
21+
22+
- **GitHub Repository:** `ruff <https://github.com/astral-sh/ruff>`_
23+
24+
Ruff offers full parity with pydocstyle along with advanced features, better support for the latest Python versions, and ongoing development to ensure a top-notch linting experience. We highly recommend pydocstyle users to switch over to ruff for a seamless transition.
25+
26+
27+
A Heartfelt Thank You
28+
-----------------------
29+
30+
We want to express our heartfelt gratitude to the pydocstyle community, maintainers, and contributors for their support and dedication over the years. Your contributions have been invaluable, and we appreciate the time and effort you've invested in making pydocstyle a valuable tool for the Python community.
31+
32+
Thank you for your support of pydocstyle in the past.
33+
34+
35+
36+
---------
37+
38+
439

540
.. image:: https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg
641
:target: https://github.com/PyCQA/pydocstyle/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster

0 commit comments

Comments
 (0)