From a984e3e6d926dda1853ab26a0fd70f7eaf417d2d Mon Sep 17 00:00:00 2001 From: James Pulec Date: Thu, 3 Mar 2016 12:33:54 -0800 Subject: [PATCH] Create README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff0ec08 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +Pydocstyle mirror +============= + +Mirror of the pydocstyle (formerly pep257) package for pre-commit. + +For pre-commit see: https://github.com/pre-commit/pre-commit + +For Pydocstyle see: https://github.com/PyCQA/pydocstyle + + +### Using Pydocstyle with pre-commit + +Add this to your `.pre-commit-config.yaml`: + + - repo: git://github.com/chewse/pre-commit-mirrors-pydocstyle + sha: '' # Use the sha / tag you want to point at + hooks: + - id: pydocstyle