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 14:55:11 +0200
commit1cdfe8d91215eefaa18c398069dd9c6879a9511d (patch)
treeebfb55efbac6e82cfc70587f13b1e0db6b1600e7 /docs/ref
parent4a6f2b63d7ad5907b3d64f8e4d318e7d59b4dd5f (diff)
Prevented (and corrected) single backtick usage in docs.
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/csrf.txt2
-rw-r--r--docs/ref/forms/widgets.txt2
-rw-r--r--docs/ref/models/fields.txt2
-rw-r--r--docs/ref/request-response.txt3
6 files changed, 10 insertions, 9 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 7b5cae6e30..98bc8c4613 100644
--- a/docs/ref/contrib/gis/geoquerysets.txt
+++ b/docs/ref/contrib/gis/geoquerysets.txt
@@ -743,9 +743,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/csrf.txt b/docs/ref/csrf.txt
index 7e2a5d45d0..f181cc1fe1 100644
--- a/docs/ref/csrf.txt
+++ b/docs/ref/csrf.txt
@@ -531,7 +531,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/forms/widgets.txt b/docs/ref/forms/widgets.txt
index 5a54051cda..76c8dd7a35 100644
--- a/docs/ref/forms/widgets.txt
+++ b/docs/ref/forms/widgets.txt
@@ -365,7 +365,7 @@ foundation for custom widgets.
the ``name`` attribute on each subwidget. In this case, for each
``(key, widget)`` pair, the key will be appended to the ``name`` of the
widget in order to generate the attribute value. You may provide the
- empty string (`''`) for a single key, in order to suppress the suffix
+ empty string (``''``) for a single key, in order to suppress the suffix
for one widget. For example::
>>> widget = MultiWidget(widgets={'': TextInput, 'last': TextInput})
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index b896fbb29d..7c5401046b 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 fbe7a26a05..cce0fb7779 100644
--- a/docs/ref/request-response.txt
+++ b/docs/ref/request-response.txt
@@ -798,7 +798,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,