From f577e3dced6179047ddb7c1b1367b448c80aa11a Mon Sep 17 00:00:00 2001
From: jsh9 <25124332+jsh9@users.noreply.github.com>
Date: Mon, 15 May 2023 03:12:07 -0700
Subject: [PATCH] Add note about pydocstyle in README

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 0101fc7..68ee5da 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,8 @@ Here is a comparison of running time on some famous Python projects:
 
 Currently, `pydoclint` only works when you write your docstrings in the [numpy stlyle](https://numpydoc.readthedocs.io/en/latest/format.html). Support for the [Google style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html) docstrings will be added soon.
 
+**Note**: this linter and [pydocstyle](https://github.com/PyCQA/pydocstyle) serves complementary purposes. It is recommended that you use both together.
+
 ## 1. Installation
 
 ```