diff options
| author | Adam Johnson <me@adamj.eu> | 2020-03-31 09:37:38 +0100 |
|---|---|---|
| committer | Carlton Gibson <carlton.gibson@noumenal.es> | 2020-04-01 14:55:11 +0200 |
| commit | 1cdfe8d91215eefaa18c398069dd9c6879a9511d (patch) | |
| tree | ebfb55efbac6e82cfc70587f13b1e0db6b1600e7 /docs/releases | |
| parent | 4a6f2b63d7ad5907b3d64f8e4d318e7d59b4dd5f (diff) | |
Prevented (and corrected) single backtick usage in docs.
Diffstat (limited to 'docs/releases')
| -rw-r--r-- | docs/releases/0.95.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.11.1.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.11.txt | 8 | ||||
| -rw-r--r-- | docs/releases/1.2.txt | 20 | ||||
| -rw-r--r-- | docs/releases/1.4.13.txt | 4 | ||||
| -rw-r--r-- | docs/releases/1.4.18.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.4.txt | 24 | ||||
| -rw-r--r-- | docs/releases/1.5.8.txt | 4 | ||||
| -rw-r--r-- | docs/releases/1.5.txt | 4 | ||||
| -rw-r--r-- | docs/releases/1.6.10.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.6.5.txt | 4 | ||||
| -rw-r--r-- | docs/releases/1.6.txt | 4 | ||||
| -rw-r--r-- | docs/releases/1.7.1.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.7.3.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.7.txt | 6 | ||||
| -rw-r--r-- | docs/releases/1.8.1.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.8.3.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.8.6.txt | 2 | ||||
| -rw-r--r-- | docs/releases/1.8.txt | 8 | ||||
| -rw-r--r-- | docs/releases/1.9.txt | 4 | ||||
| -rw-r--r-- | docs/releases/2.0.4.txt | 4 | ||||
| -rw-r--r-- | docs/releases/2.2.8.txt | 2 | ||||
| -rw-r--r-- | docs/releases/2.2.txt | 2 |
23 files changed, 58 insertions, 58 deletions
diff --git a/docs/releases/0.95.txt b/docs/releases/0.95.txt index 21fdd15320..06248c0bc0 100644 --- a/docs/releases/0.95.txt +++ b/docs/releases/0.95.txt @@ -109,7 +109,7 @@ many common questions appear with some regularity, and any particular problem may already have been answered. Finally, for those who prefer the more immediate feedback offered by IRC, -there's a `#django` channel on irc.freenode.net that is regularly populated +there's a ``#django`` channel on irc.freenode.net that is regularly populated by Django users and developers from around the world. Friendly people are usually available at any hour of the day -- to help, or just to chat. diff --git a/docs/releases/1.11.1.txt b/docs/releases/1.11.1.txt index 33caed43a8..076691be7d 100644 --- a/docs/releases/1.11.1.txt +++ b/docs/releases/1.11.1.txt @@ -10,7 +10,7 @@ Allowed disabling server-side cursors on PostgreSQL =================================================== The change in Django 1.11 to make :meth:`.QuerySet.iterator()` use server-side -cursors on PostgreSQL prevents running Django with `pgBouncer` in transaction +cursors on PostgreSQL prevents running Django with pgBouncer in transaction pooling mode. To reallow that, use the :setting:`DISABLE_SERVER_SIDE_CURSORS <DATABASE-DISABLE_SERVER_SIDE_CURSORS>` setting in :setting:`DATABASES`. diff --git a/docs/releases/1.11.txt b/docs/releases/1.11.txt index bb7c06fe9f..1b65cc3e28 100644 --- a/docs/releases/1.11.txt +++ b/docs/releases/1.11.txt @@ -185,8 +185,8 @@ Minor features * PostGIS migrations can now change field dimensions. -* Added the ability to pass the `size`, `shape`, and `offset` parameter when - creating :class:`~django.contrib.gis.gdal.GDALRaster` objects. +* Added the ability to pass the ``size``, ``shape``, and ``offset`` parameters + when creating :class:`~django.contrib.gis.gdal.GDALRaster` objects. * Added SpatiaLite support for the :class:`~django.contrib.gis.db.models.functions.IsValid` function, @@ -644,8 +644,8 @@ Server-side cursors on PostgreSQL --------------------------------- The change to make :meth:`.QuerySet.iterator()` use server-side cursors on -PostgreSQL prevents running Django with `pgBouncer` in transaction pooling -mode. To reallow that, use the :setting:`DISABLE_SERVER_SIDE_CURSORS +PostgreSQL prevents running Django with pgBouncer in transaction pooling mode. +To reallow that, use the :setting:`DISABLE_SERVER_SIDE_CURSORS <DATABASE-DISABLE_SERVER_SIDE_CURSORS>` setting (added in Django 1.11.1) in :setting:`DATABASES`. diff --git a/docs/releases/1.2.txt b/docs/releases/1.2.txt index e91c161bb4..d735d22f74 100644 --- a/docs/releases/1.2.txt +++ b/docs/releases/1.2.txt @@ -811,16 +811,16 @@ This affects the following settings: ========================================= ========================== Old setting New Setting ========================================= ========================== -`DATABASE_ENGINE` :setting:`ENGINE <DATABASE-ENGINE>` -`DATABASE_HOST` :setting:`HOST` -`DATABASE_NAME` :setting:`NAME` -`DATABASE_OPTIONS` :setting:`OPTIONS` -`DATABASE_PASSWORD` :setting:`PASSWORD` -`DATABASE_PORT` :setting:`PORT` -`DATABASE_USER` :setting:`USER` -`TEST_DATABASE_CHARSET` :setting:`TEST_CHARSET` -`TEST_DATABASE_COLLATION` :setting:`TEST_COLLATION` -`TEST_DATABASE_NAME` :setting:`TEST_NAME` +``DATABASE_ENGINE`` :setting:`ENGINE <DATABASE-ENGINE>` +``DATABASE_HOST`` :setting:`HOST` +``DATABASE_NAME`` :setting:`NAME` +``DATABASE_OPTIONS`` :setting:`OPTIONS` +``DATABASE_PASSWORD`` :setting:`PASSWORD` +``DATABASE_PORT`` :setting:`PORT` +``DATABASE_USER`` :setting:`USER` +``TEST_DATABASE_CHARSET`` :setting:`TEST_CHARSET` +``TEST_DATABASE_COLLATION`` :setting:`TEST_COLLATION` +``TEST_DATABASE_NAME`` :setting:`TEST_NAME` ========================================= ========================== These changes are also required if you have manually created a database diff --git a/docs/releases/1.4.13.txt b/docs/releases/1.4.13.txt index 89b4473e55..54f131e7d3 100644 --- a/docs/releases/1.4.13.txt +++ b/docs/releases/1.4.13.txt @@ -40,8 +40,8 @@ Django relies on user input in some cases (e.g. :doc:`i18n </topics/i18n/index>`) to redirect the user to an "on success" URL. The security checks for these redirects (namely ``django.utils.http.is_safe_url()``) did not correctly validate some malformed -URLs, such as `http:\\\\\\djangoproject.com`, which are accepted by some browsers -with more liberal URL parsing. +URLs, such as ``http:\\\\\\djangoproject.com``, which are accepted by some +browsers with more liberal URL parsing. To remedy this, the validation in ``is_safe_url()`` has been tightened to be able to handle and correctly validate these malformed URLs. diff --git a/docs/releases/1.4.18.txt b/docs/releases/1.4.18.txt index 075e08b32a..f120f9c10d 100644 --- a/docs/releases/1.4.18.txt +++ b/docs/releases/1.4.18.txt @@ -12,7 +12,7 @@ WSGI header spoofing via underscore/dash conflation When HTTP headers are placed into the WSGI environ, they are normalized by converting to uppercase, converting all dashes to underscores, and prepending -`HTTP_`. For instance, a header ``X-Auth-User`` would become +``HTTP_``. For instance, a header ``X-Auth-User`` would become ``HTTP_X_AUTH_USER`` in the WSGI environ (and thus also in Django's ``request.META`` dictionary). diff --git a/docs/releases/1.4.txt b/docs/releases/1.4.txt index 0fa81b3554..6f74bfa660 100644 --- a/docs/releases/1.4.txt +++ b/docs/releases/1.4.txt @@ -634,9 +634,9 @@ Django 1.4 also includes several smaller improvements worth noting: :meth:`~django.db.models.query.QuerySet.distinct`. * The admin login page will add a password reset link if you include a URL with - the name `'admin_password_reset'` in your urls.py, so plugging in the built-in - password reset mechanism and making it available is now much easier. For - details, see :ref:`auth_password_reset`. + the name ``'admin_password_reset'`` in your urls.py, so plugging in the + built-in password reset mechanism and making it available is now much easier. + For details, see :ref:`auth_password_reset`. * The MySQL database backend can now make use of the savepoint feature implemented by MySQL version 5.0.3 or newer with the InnoDB storage engine. @@ -671,9 +671,9 @@ vulnerabilities. No Django site should ever be run without a :setting:`SECRET_KEY`. In Django 1.4, starting Django with an empty :setting:`SECRET_KEY` will raise a -`DeprecationWarning`. In Django 1.5, it will raise an exception and Django will -refuse to start. This is slightly accelerated from the usual deprecation path -due to the severity of the consequences of running Django with no +``DeprecationWarning``. In Django 1.5, it will raise an exception and Django +will refuse to start. This is slightly accelerated from the usual deprecation +path due to the severity of the consequences of running Django with no :setting:`SECRET_KEY`. ``django.contrib.admin`` @@ -909,8 +909,8 @@ doesn't make any effort to synchronize access to the underlying backend. Concurrency behavior is defined by the underlying backend implementation. Check their documentation for details. -`COMMENTS_BANNED_USERS_GROUP` setting -------------------------------------- +``COMMENTS_BANNED_USERS_GROUP`` setting +--------------------------------------- Django's comments has historically supported excluding the comments of a special user group, but we've never @@ -946,8 +946,8 @@ Save this model manager in your custom comment app (e.g., in objects = BanningCommentManager() -`IGNORABLE_404_STARTS` and `IGNORABLE_404_ENDS` settings --------------------------------------------------------- +``IGNORABLE_404_STARTS`` and ``IGNORABLE_404_ENDS`` settings +------------------------------------------------------------ Until Django 1.3, it was possible to exclude some URLs from Django's :doc:`404 error reporting</howto/error-reporting>` by adding prefixes to @@ -1294,8 +1294,8 @@ Now, the flags are keyword arguments of :meth:`@register.filter See :ref:`filters and auto-escaping <filters-auto-escaping>` for more information. -Wildcard expansion of application names in `INSTALLED_APPS` ------------------------------------------------------------ +Wildcard expansion of application names in ``INSTALLED_APPS`` +------------------------------------------------------------- Until Django 1.3, :setting:`INSTALLED_APPS` accepted wildcards in application names, like ``django.contrib.*``. The expansion was performed by a diff --git a/docs/releases/1.5.8.txt b/docs/releases/1.5.8.txt index 136b953185..53b0c7d486 100644 --- a/docs/releases/1.5.8.txt +++ b/docs/releases/1.5.8.txt @@ -40,8 +40,8 @@ Django relies on user input in some cases (e.g. :doc:`i18n </topics/i18n/index>`) to redirect the user to an "on success" URL. The security checks for these redirects (namely ``django.utils.http.is_safe_url()``) did not correctly validate some malformed -URLs, such as `http:\\\\\\djangoproject.com`, which are accepted by some browsers -with more liberal URL parsing. +URLs, such as ``http:\\\\\\djangoproject.com``, which are accepted by some +browsers with more liberal URL parsing. To remedy this, the validation in ``is_safe_url()`` has been tightened to be able to handle and correctly validate these malformed URLs. diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt index 3113d3fa34..502667c0f1 100644 --- a/docs/releases/1.5.txt +++ b/docs/releases/1.5.txt @@ -615,8 +615,8 @@ database state behind or unit tests that rely on some form of state being preserved after the execution of other tests. Such tests are already very fragile, and must now be changed to be able to run independently. -`cleaned_data` dictionary kept for invalid forms ------------------------------------------------- +``cleaned_data`` dictionary kept for invalid forms +-------------------------------------------------- The :attr:`~django.forms.Form.cleaned_data` dictionary is now always present after form validation. When the form doesn't validate, it contains only the diff --git a/docs/releases/1.6.10.txt b/docs/releases/1.6.10.txt index ee91dc8a3a..3e20536eea 100644 --- a/docs/releases/1.6.10.txt +++ b/docs/releases/1.6.10.txt @@ -11,7 +11,7 @@ WSGI header spoofing via underscore/dash conflation When HTTP headers are placed into the WSGI environ, they are normalized by converting to uppercase, converting all dashes to underscores, and prepending -`HTTP_`. For instance, a header ``X-Auth-User`` would become +``HTTP_``. For instance, a header ``X-Auth-User`` would become ``HTTP_X_AUTH_USER`` in the WSGI environ (and thus also in Django's ``request.META`` dictionary). diff --git a/docs/releases/1.6.5.txt b/docs/releases/1.6.5.txt index 77e82a668f..4c466f9fc6 100644 --- a/docs/releases/1.6.5.txt +++ b/docs/releases/1.6.5.txt @@ -40,8 +40,8 @@ Django relies on user input in some cases (e.g. :doc:`i18n </topics/i18n/index>`) to redirect the user to an "on success" URL. The security checks for these redirects (namely ``django.utils.http.is_safe_url()``) did not correctly validate some malformed -URLs, such as `http:\\\\\\djangoproject.com`, which are accepted by some browsers -with more liberal URL parsing. +URLs, such as ``http:\\\\\\djangoproject.com``, which are accepted by some +browsers with more liberal URL parsing. To remedy this, the validation in ``is_safe_url()`` has been tightened to be able to handle and correctly validate these malformed URLs. diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt index 53bae5b049..7dc57ee11b 100644 --- a/docs/releases/1.6.txt +++ b/docs/releases/1.6.txt @@ -731,7 +731,7 @@ Admin views ``_changelist_filters`` GET parameter ------------------------------------------------- To achieve preserving and restoring list view filters, admin views now -pass around the `_changelist_filters` GET parameter. It's important that you +pass around the ``_changelist_filters`` GET parameter. It's important that you account for that change if you have custom admin templates or if your tests rely on the previous URLs. If you want to revert to the original behavior you can set the @@ -924,7 +924,7 @@ Miscellaneous url(r'^reset/done/$', 'django.contrib.auth.views.password_reset_complete', name='password_reset_complete') -* :class:`~django.views.generic.base.RedirectView` now has a `pattern_name` +* :class:`~django.views.generic.base.RedirectView` now has a ``pattern_name`` attribute which allows it to choose the target by reversing the URL. * In Django 1.4 and 1.5, a blank string was unintentionally not considered to diff --git a/docs/releases/1.7.1.txt b/docs/releases/1.7.1.txt index 9fa2bdcd10..bb30e2c62d 100644 --- a/docs/releases/1.7.1.txt +++ b/docs/releases/1.7.1.txt @@ -38,7 +38,7 @@ Bugfixes adds a ``get_absolute_url()`` method to any model that appears in ``ABSOLUTE_URL_OVERRIDES`` but doesn't define ``get_absolute_url()``. -* Avoided masking some `ImportError` exceptions during application loading +* Avoided masking some ``ImportError`` exceptions during application loading (:ticket:`22920`). * Empty ``index_together`` or ``unique_together`` model options no longer diff --git a/docs/releases/1.7.3.txt b/docs/releases/1.7.3.txt index fb33b98883..4864f8a060 100644 --- a/docs/releases/1.7.3.txt +++ b/docs/releases/1.7.3.txt @@ -11,7 +11,7 @@ WSGI header spoofing via underscore/dash conflation When HTTP headers are placed into the WSGI environ, they are normalized by converting to uppercase, converting all dashes to underscores, and prepending -`HTTP_`. For instance, a header ``X-Auth-User`` would become +``HTTP_``. For instance, a header ``X-Auth-User`` would become ``HTTP_X_AUTH_USER`` in the WSGI environ (and thus also in Django's ``request.META`` dictionary). diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 71688eb80f..db3f6720ea 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -479,7 +479,7 @@ Minor features * The ``"django.contrib.sessions.backends.cached_db"`` session backend now respects :setting:`SESSION_CACHE_ALIAS`. In previous versions, it always used - the `default` cache. + the ``default`` cache. :mod:`django.contrib.sitemaps` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1121,9 +1121,9 @@ as ``error_list``; ``error_dict``; or the return value of would have previously found strings. Also if you directly assigned the return value of ``update_error_dict()`` -to ``Form._errors`` you may inadvertently add `list` instances where +to ``Form._errors`` you may inadvertently add ``list`` instances where ``ErrorList`` instances are expected. This is a problem because unlike a -simple `list`, an ``ErrorList`` knows how to handle instances of +simple ``list``, an ``ErrorList`` knows how to handle instances of ``ValidationError``. Most use-cases that warranted using these private APIs are now covered by diff --git a/docs/releases/1.8.1.txt b/docs/releases/1.8.1.txt index 09b602c5c4..085bfe3ace 100644 --- a/docs/releases/1.8.1.txt +++ b/docs/releases/1.8.1.txt @@ -84,7 +84,7 @@ Bugfixes ``ModelAdmin.filter_horizontal`` and ``filter_vertical`` options (:ticket:`24676`). -* Fixed `AttributeError: function 'GDALAllRegister' not found` error when +* Fixed ``AttributeError: function 'GDALAllRegister' not found`` error when initializing ``contrib.gis`` on Windows. Optimizations diff --git a/docs/releases/1.8.3.txt b/docs/releases/1.8.3.txt index 5e01a131a2..ccdb31b7f3 100644 --- a/docs/releases/1.8.3.txt +++ b/docs/releases/1.8.3.txt @@ -152,4 +152,4 @@ Bugfixes * Fixed a regression in ``URLValidator`` that invalidated Punycode TLDs (:ticket:`25059`). -* Improved `pyinotify` ``runserver`` polling (:ticket:`23882`). +* Improved ``pyinotify`` ``runserver`` polling (:ticket:`23882`). diff --git a/docs/releases/1.8.6.txt b/docs/releases/1.8.6.txt index b9093e427f..c87f2607c7 100644 --- a/docs/releases/1.8.6.txt +++ b/docs/releases/1.8.6.txt @@ -36,7 +36,7 @@ Bugfixes migrations using ``QuerySet.defer()`` from leaking to test and application code. -* Fixed a typo in the name of the `strictly_above` PostGIS lookup +* Fixed a typo in the name of the ``strictly_above`` PostGIS lookup (:ticket:`25592`). * Fixed crash with ``contrib.postgres.forms.SplitArrayField`` and diff --git a/docs/releases/1.8.txt b/docs/releases/1.8.txt index 01f250e3b0..0947874ebd 100644 --- a/docs/releases/1.8.txt +++ b/docs/releases/1.8.txt @@ -753,10 +753,10 @@ in :doc:`/howto/custom-management-commands`. Custom test management command arguments through test runner ------------------------------------------------------------ -The method to add custom arguments to the `test` management command through the -test runner has changed. Previously, you could provide an `option_list` class -variable on the test runner to add more arguments (à la :py:mod:`optparse`). -Now to implement the same behavior, you have to create an +The method to add custom arguments to the ``test`` management command through +the test runner has changed. Previously, you could provide an ``option_list`` +class variable on the test runner to add more arguments (à la +:py:mod:`optparse`). Now to implement the same behavior, you have to create an ``add_arguments(cls, parser)`` class method on the test runner and call ``parser.add_argument`` to add any custom arguments, as parser is now an :py:class:`argparse.ArgumentParser` instance. diff --git a/docs/releases/1.9.txt b/docs/releases/1.9.txt index 2fdf361af1..54c02a2762 100644 --- a/docs/releases/1.9.txt +++ b/docs/releases/1.9.txt @@ -1115,7 +1115,7 @@ Miscellaneous :attr:`~django.forms.CharField.strip` argument to ``False``. * Template text that is translated and uses two or more consecutive percent - signs, e.g. ``"%%"``, may have a new `msgid` after ``makemessages`` is run + signs, e.g. ``"%%"``, may have a new ``msgid`` after ``makemessages`` is run (most likely the translation will be marked fuzzy). The new ``msgid`` will be marked ``"#, python-format"``. @@ -1506,7 +1506,7 @@ remove usage of these features. * Database test settings as independent entries in the database settings, prefixed by ``TEST_``, are no longer 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` is removed. * The default value of the diff --git a/docs/releases/2.0.4.txt b/docs/releases/2.0.4.txt index fa6accb9fb..b16c53f510 100644 --- a/docs/releases/2.0.4.txt +++ b/docs/releases/2.0.4.txt @@ -12,8 +12,8 @@ Bugfixes * Fixed a crash when filtering with an ``Exists()`` annotation of a queryset containing a single field (:ticket:`29195`). -* Fixed admin autocomplete widget's translations for `zh-hans` and `zh-hant` - languages (:ticket:`29213`). +* Fixed admin autocomplete widget's translations for ``zh-hans`` and + ``zh-hant`` languages (:ticket:`29213`). * Corrected admin's autocomplete widget to add a space after custom classes (:ticket:`29221`). diff --git a/docs/releases/2.2.8.txt b/docs/releases/2.2.8.txt index e82483c18d..76a6ad4f23 100644 --- a/docs/releases/2.2.8.txt +++ b/docs/releases/2.2.8.txt @@ -49,7 +49,7 @@ Bugfixes * Fixed a data loss possibility in the admin changelist view when a custom :ref:`formset's prefix <formset-prefix>` contains regular expression special - characters, e.g. `'$'` (:ticket:`31031`). + characters, e.g. ``'$'`` (:ticket:`31031`). * Fixed a regression in Django 2.2.1 that caused a crash when migrating permissions for proxy models with a multiple database setup if the diff --git a/docs/releases/2.2.txt b/docs/releases/2.2.txt index 7c989b0154..5c08fa19c2 100644 --- a/docs/releases/2.2.txt +++ b/docs/releases/2.2.txt @@ -458,7 +458,7 @@ Miscellaneous :func:`~django.contrib.sitemaps.ping_google` function, set the new ``sitemap_uses_https`` argument to ``False``. -* :djadmin:`runserver` no longer supports `pyinotify` (replaced by Watchman). +* :djadmin:`runserver` no longer supports ``pyinotify`` (replaced by Watchman). * The :class:`~django.db.models.Avg`, :class:`~django.db.models.StdDev`, and :class:`~django.db.models.Variance` aggregate functions now return a |
