summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorAdam Johnson <me@adamj.eu>2020-03-31 09:37:38 +0100
committerCarlton Gibson <carlton.gibson@noumenal.es>2020-04-01 15:15:21 +0200
commit0342d47e7a8571242a570b91dea3c137436740d4 (patch)
treeba498b92af4257836298bd28d5be9ec6458799ae /docs/ref
parentc9437596fe54fb5cf0330ee5a96e260903a2d683 (diff)
[3.0.x] Prevented (and corrected) single backtick usage in docs.
Backport of 1cdfe8d91215eefaa18c398069dd9c6879a9511d from master.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/gis/geoip2.txt4
-rw-r--r--docs/ref/contrib/gis/geoquerysets.txt6
-rw-r--r--docs/ref/contrib/postgres/search.txt2
-rw-r--r--docs/ref/csrf.txt2
-rw-r--r--docs/ref/django-admin.txt2
-rw-r--r--docs/ref/models/fields.txt2
-rw-r--r--docs/ref/request-response.txt3
7 files changed, 11 insertions, 10 deletions
diff --git a/docs/ref/contrib/gis/geoip2.txt b/docs/ref/contrib/gis/geoip2.txt
index abf0a7ca91..83593f0ae1 100644
--- a/docs/ref/contrib/gis/geoip2.txt
+++ b/docs/ref/contrib/gis/geoip2.txt
@@ -9,8 +9,8 @@ The :class:`GeoIP2` object is a wrapper for the `MaxMind geoip2 Python
library`__. [#]_
In order to perform IP-based geolocation, the :class:`GeoIP2` object requires
-the `geoip2 Python library`__ and the GeoIP `Country` and/or `City` `datasets
-in binary format`__ (the CSV files will not work!). Grab the
+the `geoip2 Python library`__ and the GeoIP ``Country`` and/or ``City``
+`datasets in binary format`__ (the CSV files will not work!). Grab the
``GeoLite2-Country.mmdb.gz`` and ``GeoLite2-City.mmdb.gz`` files and unzip them
in a directory corresponding to the :setting:`GEOIP_PATH` setting.
diff --git a/docs/ref/contrib/gis/geoquerysets.txt b/docs/ref/contrib/gis/geoquerysets.txt
index 090f283075..de3a63d924 100644
--- a/docs/ref/contrib/gis/geoquerysets.txt
+++ b/docs/ref/contrib/gis/geoquerysets.txt
@@ -746,9 +746,9 @@ Distance lookups take the following form::
The value passed into a distance lookup is a tuple; the first two
values are mandatory, and are the geometry to calculate distances to,
and a distance value (either a number in units of the field, a
-:class:`~django.contrib.gis.measure.Distance` object, or a `query expression
-<ref/models/expressions>`). To pass a band index to the lookup, use a 3-tuple
-where the second entry is the band index.
+:class:`~django.contrib.gis.measure.Distance` object, or a :doc:`query
+expression </ref/models/expressions>`). To pass a band index to the lookup, use
+a 3-tuple where the second entry is the band index.
On every distance lookup except :lookup:`dwithin`, an optional element,
``'spheroid'``, may be included to use the more accurate spheroid distance
diff --git a/docs/ref/contrib/postgres/search.txt b/docs/ref/contrib/postgres/search.txt
index 367171d128..17a5ea2db6 100644
--- a/docs/ref/contrib/postgres/search.txt
+++ b/docs/ref/contrib/postgres/search.txt
@@ -104,7 +104,7 @@ See :ref:`postgresql-fts-search-configuration` for an explanation of the
.. versionadded:: 2.2
- The `search_type` parameter was added.
+ The ``search_type`` parameter was added.
``SearchRank``
==============
diff --git a/docs/ref/csrf.txt b/docs/ref/csrf.txt
index ee6d0643fe..20a8ddb433 100644
--- a/docs/ref/csrf.txt
+++ b/docs/ref/csrf.txt
@@ -541,7 +541,7 @@ Is it a problem that Django's CSRF protection isn't linked to a session by defau
-----------------------------------------------------------------------------------
No, this is by design. Not linking CSRF protection to a session allows using
-the protection on sites such as a `pastebin` that allow submissions from
+the protection on sites such as a *pastebin* that allow submissions from
anonymous users which don't have a session.
If you wish to store the CSRF token in the user's session, use the
diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt
index f3e42aa367..c5b56957d2 100644
--- a/docs/ref/django-admin.txt
+++ b/docs/ref/django-admin.txt
@@ -923,7 +923,7 @@ more robust change detection, and a reduction in power usage. Django supports
.. versionchanged:: 2.2
- Watchman support replaced support for `pyinotify`.
+ Watchman support replaced support for ``pyinotify``.
When you start the server, and each time you change Python code while the
server is running, the system check framework will check your entire Django
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 0f0544e6fc..4429b7f946 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -153,7 +153,7 @@ The first element in each tuple is the name to apply to the group. The
second element is an iterable of 2-tuples, with each 2-tuple containing
a value and a human-readable name for an option. Grouped options may be
combined with ungrouped options within a single list (such as the
-`unknown` option in this example).
+``'unknown'`` option in this example).
For each model field that has :attr:`~Field.choices` set, Django will add a
method to retrieve the human-readable name for the field's current value. See
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt
index 6afb180389..73dfe75fb6 100644
--- a/docs/ref/request-response.txt
+++ b/docs/ref/request-response.txt
@@ -765,7 +765,8 @@ Methods
``content_type`` is the MIME type optionally completed by a character set
encoding and is used to fill the HTTP ``Content-Type`` header. If not
specified, it is formed by ``'text/html'`` and the
- :setting:`DEFAULT_CHARSET` settings, by default: "`text/html; charset=utf-8`".
+ :setting:`DEFAULT_CHARSET` settings, by default:
+ ``"text/html; charset=utf-8"``.
``status`` is the :rfc:`HTTP status code <7231#section-6>` for the response.
You can use Python's :py:class:`http.HTTPStatus` for meaningful aliases,