summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2022-05-31 07:40:54 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-06-27 07:44:27 +0200
commit6c0ee6179796aa67a2403d85f2759bd4d45c93bc (patch)
treeb505f8d05ae716475252c0499435fee185d1ed64 /docs/internals/contributing/writing-code
parentd783ce3d8df10b9b8c99d67418d45934238a49db (diff)
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
sphinxcontrib-spelling 7.5.0+ includes captions of figures in the set of nodes for which the text is checked. Backport of ac90529cc58507d9a07610809a795ec5fc3cbf8c from main
Diffstat (limited to 'docs/internals/contributing/writing-code')
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt2
-rw-r--r--docs/internals/contributing/writing-code/unit-tests.txt2
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt
index 1bfe01bab5..522226086b 100644
--- a/docs/internals/contributing/writing-code/coding-style.txt
+++ b/docs/internals/contributing/writing-code/coding-style.txt
@@ -171,7 +171,7 @@ Imports
For example (comments are for explanatory purposes only):
.. code-block:: python
- :caption: django/contrib/admin/example.py
+ :caption: ``django/contrib/admin/example.py``
# future
from __future__ import unicode_literals
diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt
index 942d78a268..62a3e31462 100644
--- a/docs/internals/contributing/writing-code/unit-tests.txt
+++ b/docs/internals/contributing/writing-code/unit-tests.txt
@@ -564,7 +564,7 @@ Since this pattern involves a lot of boilerplate, Django provides the
installed, you should pass the set of targeted ``app_label`` as arguments:
.. code-block:: python
- :caption: tests/app_label/tests.py
+ :caption: ``tests/app_label/tests.py``
from django.db import models
from django.test import SimpleTestCase