From af244e47ccc88860fe928fec96c7873e3e4017fe Mon Sep 17 00:00:00 2001 From: Luke Plant Date: Mon, 10 Oct 2011 15:32:01 +0000 Subject: [PATCH] Fixed a bunch of ReST errors that resulted in interpretation as block quotations git-svn-id: http://code.djangoproject.com/svn/django/trunk@16954 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/ref/contrib/admin/index.txt | 4 +- docs/ref/contrib/comments/example.txt | 2 +- docs/ref/contrib/localflavor.txt | 2 +- docs/ref/models/querysets.txt | 58 +++++++++++++-------------- docs/releases/1.0-alpha-1.txt | 18 ++++----- docs/releases/1.0-alpha-2.txt | 8 ++-- docs/releases/1.0-beta-2.txt | 6 +-- docs/releases/1.0-beta.txt | 8 ++-- docs/releases/1.0.txt | 2 +- docs/topics/auth.txt | 2 +- docs/topics/templates.txt | 2 + 11 files changed, 57 insertions(+), 55 deletions(-) diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index 02e539e6f2..875c234f03 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -230,7 +230,7 @@ subclass:: This results in an admin page that looks like: - .. image:: _images/flatfiles_admin.png + .. image:: _images/flatfiles_admin.png If neither ``fieldsets`` nor :attr:`~ModelAdmin.fields` options are present, Django will default to displaying each field that isn't an ``AutoField`` and @@ -577,7 +577,7 @@ subclass:: Set ``list_filter`` to activate filters in the right sidebar of the change list page of the admin, as illustrated in the following screenshot: - .. image:: _images/users_changelist.png + .. image:: _images/users_changelist.png ``list_filter`` should be a list of elements, where each element should be of one of the following types: diff --git a/docs/ref/contrib/comments/example.txt b/docs/ref/contrib/comments/example.txt index 82ae08e66d..e009422b4e 100644 --- a/docs/ref/contrib/comments/example.txt +++ b/docs/ref/contrib/comments/example.txt @@ -40,7 +40,7 @@ available in the context, then you can refer to it directly:: .. versionadded:: 1.2 Next, we can use the :ttag:`render_comment_list` tag, to render all comments -to the given instance (``entry``) by using the ``comments/list.html`` template. +to the given instance (``entry``) by using the ``comments/list.html`` template:: {% render_comment_list for entry %} diff --git a/docs/ref/contrib/localflavor.txt b/docs/ref/contrib/localflavor.txt index fbb10a6a35..99077be0de 100644 --- a/docs/ref/contrib/localflavor.txt +++ b/docs/ref/contrib/localflavor.txt @@ -824,7 +824,7 @@ Mexico (``mx``) .. class:: mx.forms.MXCURPField - .. versionadded:: 1.4 + .. versionadded:: 1.4 A field that validates a Mexican *Clave Única de Registro de Población*. diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt index 11ef73059d..8a3d15cc05 100644 --- a/docs/ref/models/querysets.txt +++ b/docs/ref/models/querysets.txt @@ -936,49 +936,49 @@ of the arguments is required, but you should use at least one of them. * ``order_by`` - If you need to order the resulting queryset using some of the new - fields or tables you have included via ``extra()`` use the ``order_by`` - parameter to ``extra()`` and pass in a sequence of strings. These - strings should either be model fields (as in the normal - :meth:`order_by()` method on querysets), of the form - ``table_name.column_name`` or an alias for a column that you specified - in the ``select`` parameter to ``extra()``. + If you need to order the resulting queryset using some of the new + fields or tables you have included via ``extra()`` use the ``order_by`` + parameter to ``extra()`` and pass in a sequence of strings. These + strings should either be model fields (as in the normal + :meth:`order_by()` method on querysets), of the form + ``table_name.column_name`` or an alias for a column that you specified + in the ``select`` parameter to ``extra()``. - For example:: + For example:: - q = Entry.objects.extra(select={'is_recent': "pub_date > '2006-01-01'"}) - q = q.extra(order_by = ['-is_recent']) + q = Entry.objects.extra(select={'is_recent': "pub_date > '2006-01-01'"}) + q = q.extra(order_by = ['-is_recent']) - This would sort all the items for which ``is_recent`` is true to the - front of the result set (``True`` sorts before ``False`` in a - descending ordering). + This would sort all the items for which ``is_recent`` is true to the + front of the result set (``True`` sorts before ``False`` in a + descending ordering). - This shows, by the way, that you can make multiple calls to ``extra()`` - and it will behave as you expect (adding new constraints each time). + This shows, by the way, that you can make multiple calls to ``extra()`` + and it will behave as you expect (adding new constraints each time). * ``params`` - The ``where`` parameter described above may use standard Python - database string placeholders — ``'%s'`` to indicate parameters the - database engine should automatically quote. The ``params`` argument is - a list of any extra parameters to be substituted. + The ``where`` parameter described above may use standard Python + database string placeholders — ``'%s'`` to indicate parameters the + database engine should automatically quote. The ``params`` argument is + a list of any extra parameters to be substituted. - Example:: + Example:: - Entry.objects.extra(where=['headline=%s'], params=['Lennon']) + Entry.objects.extra(where=['headline=%s'], params=['Lennon']) - Always use ``params`` instead of embedding values directly into - ``where`` because ``params`` will ensure values are quoted correctly - according to your particular backend. For example, quotes will be - escaped correctly. + Always use ``params`` instead of embedding values directly into + ``where`` because ``params`` will ensure values are quoted correctly + according to your particular backend. For example, quotes will be + escaped correctly. - Bad:: + Bad:: - Entry.objects.extra(where=["headline='Lennon'"]) + Entry.objects.extra(where=["headline='Lennon'"]) - Good:: + Good:: - Entry.objects.extra(where=['headline=%s'], params=['Lennon']) + Entry.objects.extra(where=['headline=%s'], params=['Lennon']) defer ~~~~~ diff --git a/docs/releases/1.0-alpha-1.txt b/docs/releases/1.0-alpha-1.txt index 2b6d5cd487..d59a40e55f 100644 --- a/docs/releases/1.0-alpha-1.txt +++ b/docs/releases/1.0-alpha-1.txt @@ -32,7 +32,7 @@ Refactored admin application (newforms-admin) documentation for the admin application is available online in the official Django documentation: - :doc:`admin reference ` + * :doc:`admin reference ` Improved Unicode handling Django's internals have been refactored to use Unicode throughout; @@ -43,7 +43,7 @@ Improved Unicode handling Unicode gracefully. Details are available in Django's Unicode-handling documentation: - :doc:`unicode reference ` + * :doc:`unicode reference ` An improved Django ORM Django's object-relational mapper -- the component which provides @@ -56,8 +56,8 @@ An improved Django ORM including backwards-incompatible modifications and mentions of new features opened up by this refactoring, is available on the Django wiki: - - http://code.djangoproject.com/wiki/QuerysetRefactorBranch + + * http://code.djangoproject.com/wiki/QuerysetRefactorBranch Automatic escaping of template variables To provide improved security against cross-site scripting (XSS) @@ -84,7 +84,7 @@ Django 1.0 release, and a comprehensive list of backwards-incompatible changes is also available on the Django wiki for those who want to begin developing and testing their upgrade process: - http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges +* http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges The Django 1.0 roadmap @@ -123,7 +123,7 @@ Of course, like any estimated timeline, this is subject to change as requirements dictate. The latest information will always be available on the Django project wiki: - http://code.djangoproject.com/wiki/VersionOneRoadmap +* http://code.djangoproject.com/wiki/VersionOneRoadmap What you can do to help @@ -136,7 +136,7 @@ codebase in a safe test environment and reporting any bugs or issues you encounter. The Django ticket tracker is the central place to search for open issues: - http://code.djangoproject.com/timeline +* http://code.djangoproject.com/timeline Please open new tickets if no existing ticket corresponds to a problem you're running into. @@ -145,7 +145,7 @@ Additionally, discussion of Django development, including progress toward the 1.0 release, takes place daily on the django-developers mailing list: - http://groups.google.com/group/django-developers +* http://groups.google.com/group/django-developers ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If you're interested in helping out with Django's development, feel free @@ -154,7 +154,7 @@ to join the discussions there. Django's online documentation also includes pointers on how to contribute to Django: - :doc:`contributing to Django ` +* :doc:`contributing to Django ` Contributions on any level -- developing code, writing documentation or simply triaging tickets and helping to test proposed diff --git a/docs/releases/1.0-alpha-2.txt b/docs/releases/1.0-alpha-2.txt index 54876bf197..11955be599 100644 --- a/docs/releases/1.0-alpha-2.txt +++ b/docs/releases/1.0-alpha-2.txt @@ -98,7 +98,7 @@ Of course, like any estimated timeline, this is subject to change as requirements dictate. The latest information will always be available on the Django project wiki: - http://code.djangoproject.com/wiki/VersionOneRoadmap +* http://code.djangoproject.com/wiki/VersionOneRoadmap What you can do to help @@ -111,7 +111,7 @@ codebase in a safe test environment and reporting any bugs or issues you encounter. The Django ticket tracker is the central place to search for open issues: - http://code.djangoproject.com/timeline +* http://code.djangoproject.com/timeline Please open new tickets if no existing ticket corresponds to a problem you're running into. @@ -120,7 +120,7 @@ Additionally, discussion of Django development, including progress toward the 1.0 release, takes place daily on the django-developers mailing list: - http://groups.google.com/group/django-developers +* http://groups.google.com/group/django-developers ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If you're interested in helping out with Django's development, feel free @@ -129,7 +129,7 @@ to join the discussions there. Django's online documentation also includes pointers on how to contribute to Django: - :doc:`contributing to Django ` +* :doc:`contributing to Django ` Contributions on any level -- developing code, writing documentation or simply triaging tickets and helping to test proposed diff --git a/docs/releases/1.0-beta-2.txt b/docs/releases/1.0-beta-2.txt index 1ee75c7e16..dec5498ec9 100644 --- a/docs/releases/1.0-beta-2.txt +++ b/docs/releases/1.0-beta-2.txt @@ -94,7 +94,7 @@ codebase in a safe test environment and reporting any bugs or issues you encounter. The Django ticket tracker is the central place to search for open issues: - http://code.djangoproject.com/timeline +* http://code.djangoproject.com/timeline Please open new tickets if no existing ticket corresponds to a problem you're running into. @@ -103,7 +103,7 @@ Additionally, discussion of Django development, including progress toward the 1.0 release, takes place daily on the django-developers mailing list: - http://groups.google.com/group/django-developers +* http://groups.google.com/group/django-developers ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If you're interested in helping out with Django's development, feel free @@ -112,7 +112,7 @@ to join the discussions there. Django's online documentation also includes pointers on how to contribute to Django: - :doc:`contributing to Django ` +* :doc:`contributing to Django ` Contributions on any level -- developing code, writing documentation or simply triaging tickets and helping to test proposed diff --git a/docs/releases/1.0-beta.txt b/docs/releases/1.0-beta.txt index 5e9d297590..e4cf3de7a5 100644 --- a/docs/releases/1.0-beta.txt +++ b/docs/releases/1.0-beta.txt @@ -115,7 +115,7 @@ Of course, like any estimated timeline, this is subject to change as requirements dictate. The latest information will always be available on the Django project wiki: - http://code.djangoproject.com/wiki/VersionOneRoadmap +* http://code.djangoproject.com/wiki/VersionOneRoadmap What you can do to help @@ -128,7 +128,7 @@ codebase in a safe test environment and reporting any bugs or issues you encounter. The Django ticket tracker is the central place to search for open issues: - http://code.djangoproject.com/timeline +* http://code.djangoproject.com/timeline Please open new tickets if no existing ticket corresponds to a problem you're running into. @@ -137,7 +137,7 @@ Additionally, discussion of Django development, including progress toward the 1.0 release, takes place daily on the django-developers mailing list: - http://groups.google.com/group/django-developers +* http://groups.google.com/group/django-developers ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If you're interested in helping out with Django's development, feel free @@ -146,7 +146,7 @@ to join the discussions there. Django's online documentation also includes pointers on how to contribute to Django: - :doc:`contributing to Django ` +* :doc:`contributing to Django ` Contributions on any level -- developing code, writing documentation or simply triaging tickets and helping to test proposed diff --git a/docs/releases/1.0.txt b/docs/releases/1.0.txt index a2b6083e38..ea9e3451f6 100644 --- a/docs/releases/1.0.txt +++ b/docs/releases/1.0.txt @@ -57,7 +57,7 @@ there. In fact, new documentation is one of our favorite features of Django 1.0, so we might as well start there. First, there's a new documentation site: - http://docs.djangoproject.com/ +* http://docs.djangoproject.com/ The documentation has been greatly improved, cleaned up, and generally made awesome. There's now dedicated search, indexes, and more. diff --git a/docs/topics/auth.txt b/docs/topics/auth.txt index ecbc2f2bd1..ca927d438c 100644 --- a/docs/topics/auth.txt +++ b/docs/topics/auth.txt @@ -663,7 +663,7 @@ Manually managing a user's password .. function:: is_password_usable() - .. versionadded:: 1.4 + .. versionadded:: 1.4 Checks if the given string is a hashed password that has a chance of being verified against :func:`django.contrib.auth.utils.check_password`. diff --git a/docs/topics/templates.txt b/docs/topics/templates.txt index b96e414f10..359f97cd21 100644 --- a/docs/topics/templates.txt +++ b/docs/topics/templates.txt @@ -420,6 +420,8 @@ With this name value, the template would be rendered as:: Similarly, what if the name contained a ``'<'`` symbol, like this? +.. code-block:: html + username That would result in a rendered template like this::