From 30ca66eadd1135d220ae1f0570bb0244c26b9d29 Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 6 Mar 2020 11:52:49 +0100 Subject: [PATCH] Added missing backticks in various docs. --- docs/howto/custom-file-storage.txt | 4 ++-- docs/internals/deprecation.txt | 2 +- docs/intro/reusable-apps.txt | 2 +- docs/ref/contrib/postgres/fields.txt | 2 +- docs/ref/models/querysets.txt | 2 +- docs/topics/forms/index.txt | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/howto/custom-file-storage.txt b/docs/howto/custom-file-storage.txt index ed6e610663..33b8223b60 100644 --- a/docs/howto/custom-file-storage.txt +++ b/docs/howto/custom-file-storage.txt @@ -42,7 +42,7 @@ You'll need to follow these steps: ``django.utils.deconstruct.deconstructible`` class decorator for this (that's what Django uses on FileSystemStorage). -By default, the following methods raise `NotImplementedError` and will +By default, the following methods raise ``NotImplementedError`` and will typically have to be overridden: * :meth:`Storage.delete` @@ -56,7 +56,7 @@ omitted. As it happens, it is possible to leave each method unimplemented and still have a working Storage. By way of example, if listing the contents of certain storage backends turns -out to be expensive, you might decide not to implement `Storage.listdir`. +out to be expensive, you might decide not to implement ``Storage.listdir()``. Another example would be a backend that only handles writing to files. In this case, you would not need to implement any of the above methods. diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index a56730aef7..c32666fdb7 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -651,7 +651,7 @@ details on these changes. * Database test settings as independent entries in the database settings, prefixed by ``TEST_``, will no longer be supported. -* The `cache_choices` option to :class:`~django.forms.ModelChoiceField` and +* The ``cache_choices`` option to :class:`~django.forms.ModelChoiceField` and :class:`~django.forms.ModelMultipleChoiceField` will be removed. * The default value of the diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index c5e94debc6..3bc0188332 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -169,7 +169,7 @@ this. For a small app like polls, this process isn't too difficult. path('polls/', include('polls.urls')), - 3. Run `python manage.py migrate` to create the polls models. + 3. Run ``python manage.py migrate`` to create the polls models. 4. Start the development server and visit http://127.0.0.1:8000/admin/ to create a poll (you'll need the Admin app enabled). diff --git a/docs/ref/contrib/postgres/fields.txt b/docs/ref/contrib/postgres/fields.txt index e8fcef6215..baebba9c50 100644 --- a/docs/ref/contrib/postgres/fields.txt +++ b/docs/ref/contrib/postgres/fields.txt @@ -79,7 +79,7 @@ may be a good choice for the :ref:`range fields ` and .. note:: - When nesting ``ArrayField``, whether you use the `size` parameter or not, + When nesting ``ArrayField``, whether you use the ``size`` parameter or not, PostgreSQL requires that the arrays are rectangular:: from django.contrib.postgres.fields import ArrayField diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt index 38192d4fa6..6b042d305e 100644 --- a/docs/ref/models/querysets.txt +++ b/docs/ref/models/querysets.txt @@ -498,7 +498,7 @@ Examples (those after the first will only work on PostgreSQL):: ...wouldn't work because the query would be ordered by ``blog__name`` thus mismatching the ``DISTINCT ON`` expression. You'd have to explicitly order - by the relation `_id` field (``blog_id`` in this case) or the referenced + by the relation ``_id`` field (``blog_id`` in this case) or the referenced one (``blog__pk``) to make sure both expressions match. ``values()`` diff --git a/docs/topics/forms/index.txt b/docs/topics/forms/index.txt index b6c6df0c16..7210868625 100644 --- a/docs/topics/forms/index.txt +++ b/docs/topics/forms/index.txt @@ -355,7 +355,7 @@ from that ``{{ form }}`` by Django's template language. use the ``url``, ``email`` and ``number`` HTML5 input types. By default, browsers may apply their own validation on these fields, which may be stricter than Django's validation. If you would like to disable this - behavior, set the `novalidate` attribute on the ``form`` tag, or specify + behavior, set the ``novalidate`` attribute on the ``form`` tag, or specify a different widget on the field, like :class:`TextInput`. We now have a working web form, described by a Django :class:`Form`, processed