Skip to content

Commit d6ba4e1

Browse files
committed
Added info on use as pre-commit hook
1 parent 2a56c72 commit d6ba4e1

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

README.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,3 +149,19 @@ Code Description
149149
STRFTIME001 Linux-specific strftime code used
150150
STRFTIME002 Windows-specific strftime code used
151151
============== ====================================
152+
153+
154+
Use as a pre-commit hook
155+
--------------------------
156+
157+
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
158+
159+
Sample `.pre-commit-config.yaml`:
160+
161+
```yaml
162+
- repo: https://gitlab.com/pycqa/flake8
163+
rev: 3.8.1
164+
hooks:
165+
- id: flake8
166+
additional_dependencies: [flake8-strftime==0.1.1]
167+
```

doc-source/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,23 @@ Installation
143143

144144
.. end installation
145145
146+
147+
Use as a pre-commit hook
148+
--------------------------
149+
150+
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
151+
152+
Sample `.pre-commit-config.yaml`:
153+
154+
```yaml
155+
- repo: https://gitlab.com/pycqa/flake8
156+
rev: 3.8.1
157+
hooks:
158+
- id: flake8
159+
additional_dependencies: [flake8-strftime==0.1.1]
160+
```
161+
162+
146163
.. toctree::
147164
:hidden:
148165

0 commit comments

Comments
 (0)