Skip to content

Commit f747f5a

Browse files
committed
Added info on use as pre-commit hook (correctly formatted)
1 parent 916eef6 commit f747f5a

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

README.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -151,17 +151,18 @@ Code Description
151151
SXL001 Double backticked variable should be a link to Python documentation.
152152
============== =====================================================================
153153

154+
154155
Use as a pre-commit hook
155156
--------------------------
156157

157158
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
158159

159160
Sample `.pre-commit-config.yaml`:
160161

161-
```yaml
162-
- repo: https://gitlab.com/pycqa/flake8
163-
rev: 3.8.1
164-
hooks:
165-
- id: flake8
166-
additional_dependencies: [flake8-sphinx-links==0.0.4]
167-
```
162+
.. code-block:: yaml
163+
164+
- repo: https://gitlab.com/pycqa/flake8
165+
rev: 3.8.1
166+
hooks:
167+
- id: flake8
168+
additional_dependencies: [flake8-sphinx-links==0.0.4]

doc-source/index.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -157,13 +157,13 @@ See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
157157

158158
Sample `.pre-commit-config.yaml`:
159159

160-
```yaml
161-
- repo: https://gitlab.com/pycqa/flake8
162-
rev: 3.8.1
163-
hooks:
164-
- id: flake8
165-
additional_dependencies: [flake8-sphinx-links==0.0.4]
166-
```
160+
.. code-block:: yaml
161+
162+
- repo: https://gitlab.com/pycqa/flake8
163+
rev: 3.8.1
164+
hooks:
165+
- id: flake8
166+
additional_dependencies: [flake8-sphinx-links==0.0.4]
167167
168168
169169
.. toctree::

0 commit comments

Comments
 (0)