Add back link to Github repo in README

jsh9 · Oct 2, 2023 · eb1e3c0 · eb1e3c0
1 parent 0474b26
commit eb1e3c0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # pydoclint
 
-A Python docstring linter to check whether a docstring's sections (arguments,
-returns, raises, ...) match the function signature or function implementation.
+[_Pydoclint_](https://github.com/jsh9/pydoclint) is a Python docstring linter
+to check whether a docstring's sections (arguments, returns, raises, ...) match
+the function signature or function implementation.
 
 It runs really fast. In fact, it can be thousands of times faster than
 [darglint](https://github.com/terrencepreilly/darglint) (or its maintained fork

diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,8 @@
 # pydoclint
 
-A Python docstring linter to check whether a docstring's sections (arguments,
-returns, raises, ...) match the function signature or function implementation.
+[_Pydoclint_](https://github.com/jsh9/pydoclint) is a Python docstring linter
+to check whether a docstring's sections (arguments, returns, raises, ...) match
+the function signature or function implementation.
 
 It runs really fast. In fact, it can be thousands of times faster than
 [darglint](https://github.com/terrencepreilly/darglint) (or its maintained fork