Skip to content

Commit

Permalink
Update README (add URL to doc site and repo)
Browse files Browse the repository at this point in the history
  • Loading branch information
jsh9 committed Oct 24, 2023
1 parent b5612ff commit 7e58949
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 18 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# pydoclint

[_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.
_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
Expand All @@ -19,16 +19,20 @@ Additionally, _pydoclint_ can detect some quite a few style violations that
darglint cannot.

Currently, _pydoclint_ supports three docstring styles:

- The [numpy stlyle](https://numpydoc.readthedocs.io/en/latest/format.html)
- The
[Google style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html)
- The
[Sphinx style](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html)
[numpy](https://numpydoc.readthedocs.io/en/latest/format.html),
[Google](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html),
and
[Sphinx](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html).

Another note: this linter and [pydocstyle](https://github.com/PyCQA/pydocstyle)
serves complementary purposes. It is recommended that you use both together.

The full documentation of _pydoclint_ (including this README) can be found
here: https://jsh9.github.io/pydoclint

The corresponding Github repository of _pydoclint_ is:
https://github.com/jsh9/pydoclint

---

**Table of Contents**
Expand Down
22 changes: 13 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# pydoclint

[_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.
_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
Expand All @@ -19,16 +19,20 @@ Additionally, _pydoclint_ can detect some quite a few style violations that
darglint cannot.

Currently, _pydoclint_ supports three docstring styles:

- The [numpy stlyle](https://numpydoc.readthedocs.io/en/latest/format.html)
- The
[Google style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html)
- The
[Sphinx style](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html)
[numpy](https://numpydoc.readthedocs.io/en/latest/format.html),
[Google](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html),
and
[Sphinx](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html).

Another note: this linter and [pydocstyle](https://github.com/PyCQA/pydocstyle)
serves complementary purposes. It is recommended that you use both together.

The full documentation of _pydoclint_ (including this README) can be found
here: https://jsh9.github.io/pydoclint

The corresponding Github repository of _pydoclint_ is:
https://github.com/jsh9/pydoclint

---

**Table of Contents**
Expand Down

0 comments on commit 7e58949

Please sign in to comment.