Add note about pydocstyle in README

jsh9 · May 15, 2023 · f577e3d · f577e3d
1 parent bd95413
commit f577e3d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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
 
 ```