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
This commit is contained in:
Luke Plant 2011-10-10 15:32:01 +00:00
parent 17659adf93
commit af244e47cc
11 changed files with 57 additions and 55 deletions

View File

@ -230,7 +230,7 @@ subclass::
This results in an admin page that looks like: 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, If neither ``fieldsets`` nor :attr:`~ModelAdmin.fields` options are present,
Django will default to displaying each field that isn't an ``AutoField`` and 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 Set ``list_filter`` to activate filters in the right sidebar of the change
list page of the admin, as illustrated in the following screenshot: 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 ``list_filter`` should be a list of elements, where each element should be
of one of the following types: of one of the following types:

View File

@ -40,7 +40,7 @@ available in the context, then you can refer to it directly::
.. versionadded:: 1.2 .. versionadded:: 1.2
Next, we can use the :ttag:`render_comment_list` tag, to render all comments 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 %} {% render_comment_list for entry %}

View File

@ -824,7 +824,7 @@ Mexico (``mx``)
.. class:: mx.forms.MXCURPField .. class:: mx.forms.MXCURPField
.. versionadded:: 1.4 .. versionadded:: 1.4
A field that validates a Mexican *Clave Única de Registro de Población*. A field that validates a Mexican *Clave Única de Registro de Población*.

View File

@ -936,49 +936,49 @@ of the arguments is required, but you should use at least one of them.
* ``order_by`` * ``order_by``
If you need to order the resulting queryset using some of the new 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`` fields or tables you have included via ``extra()`` use the ``order_by``
parameter to ``extra()`` and pass in a sequence of strings. These parameter to ``extra()`` and pass in a sequence of strings. These
strings should either be model fields (as in the normal strings should either be model fields (as in the normal
:meth:`order_by()` method on querysets), of the form :meth:`order_by()` method on querysets), of the form
``table_name.column_name`` or an alias for a column that you specified ``table_name.column_name`` or an alias for a column that you specified
in the ``select`` parameter to ``extra()``. in the ``select`` parameter to ``extra()``.
For example:: For example::
q = Entry.objects.extra(select={'is_recent': "pub_date > '2006-01-01'"}) q = Entry.objects.extra(select={'is_recent': "pub_date > '2006-01-01'"})
q = q.extra(order_by = ['-is_recent']) q = q.extra(order_by = ['-is_recent'])
This would sort all the items for which ``is_recent`` is true to the 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 front of the result set (``True`` sorts before ``False`` in a
descending ordering). descending ordering).
This shows, by the way, that you can make multiple calls to ``extra()`` 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). and it will behave as you expect (adding new constraints each time).
* ``params`` * ``params``
The ``where`` parameter described above may use standard Python The ``where`` parameter described above may use standard Python
database string placeholders — ``'%s'`` to indicate parameters the database string placeholders — ``'%s'`` to indicate parameters the
database engine should automatically quote. The ``params`` argument is database engine should automatically quote. The ``params`` argument is
a list of any extra parameters to be substituted. 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 Always use ``params`` instead of embedding values directly into
``where`` because ``params`` will ensure values are quoted correctly ``where`` because ``params`` will ensure values are quoted correctly
according to your particular backend. For example, quotes will be according to your particular backend. For example, quotes will be
escaped correctly. 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 defer
~~~~~ ~~~~~

View File

@ -32,7 +32,7 @@ Refactored admin application (newforms-admin)
documentation for the admin application is available online in the documentation for the admin application is available online in the
official Django documentation: official Django documentation:
:doc:`admin reference </ref/contrib/admin/index>` * :doc:`admin reference </ref/contrib/admin/index>`
Improved Unicode handling Improved Unicode handling
Django's internals have been refactored to use Unicode throughout; 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 gracefully. Details are available in Django's
Unicode-handling documentation: Unicode-handling documentation:
:doc:`unicode reference </ref/unicode>` * :doc:`unicode reference </ref/unicode>`
An improved Django ORM An improved Django ORM
Django's object-relational mapper -- the component which provides Django's object-relational mapper -- the component which provides
@ -57,7 +57,7 @@ An improved Django ORM
features opened up by this refactoring, is available on the Django features opened up by this refactoring, is available on the Django
wiki: wiki:
http://code.djangoproject.com/wiki/QuerysetRefactorBranch * http://code.djangoproject.com/wiki/QuerysetRefactorBranch
Automatic escaping of template variables Automatic escaping of template variables
To provide improved security against cross-site scripting (XSS) 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 changes is also available on the Django wiki for those who want to
begin developing and testing their upgrade process: begin developing and testing their upgrade process:
http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges * http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges
The Django 1.0 roadmap 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 requirements dictate. The latest information will always be available
on the Django project wiki: on the Django project wiki:
http://code.djangoproject.com/wiki/VersionOneRoadmap * http://code.djangoproject.com/wiki/VersionOneRoadmap
What you can do to help 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 you encounter. The Django ticket tracker is the central place to
search for open issues: 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 Please open new tickets if no existing ticket corresponds to a problem
you're running into. 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 toward the 1.0 release, takes place daily on the django-developers
mailing list: 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 ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If
you're interested in helping out with Django's development, feel free 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 Django's online documentation also includes pointers on how to
contribute to Django: contribute to Django:
:doc:`contributing to Django </internals/contributing/index>` * :doc:`contributing to Django </internals/contributing/index>`
Contributions on any level -- developing code, writing Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed documentation or simply triaging tickets and helping to test proposed

View File

@ -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 requirements dictate. The latest information will always be available
on the Django project wiki: on the Django project wiki:
http://code.djangoproject.com/wiki/VersionOneRoadmap * http://code.djangoproject.com/wiki/VersionOneRoadmap
What you can do to help 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 you encounter. The Django ticket tracker is the central place to
search for open issues: 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 Please open new tickets if no existing ticket corresponds to a problem
you're running into. 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 toward the 1.0 release, takes place daily on the django-developers
mailing list: 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 ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If
you're interested in helping out with Django's development, feel free 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 Django's online documentation also includes pointers on how to
contribute to Django: contribute to Django:
:doc:`contributing to Django </internals/contributing/index>` * :doc:`contributing to Django </internals/contributing/index>`
Contributions on any level -- developing code, writing Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed documentation or simply triaging tickets and helping to test proposed

View File

@ -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 you encounter. The Django ticket tracker is the central place to
search for open issues: 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 Please open new tickets if no existing ticket corresponds to a problem
you're running into. 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 toward the 1.0 release, takes place daily on the django-developers
mailing list: 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 ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If
you're interested in helping out with Django's development, feel free 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 Django's online documentation also includes pointers on how to
contribute to Django: contribute to Django:
:doc:`contributing to Django </internals/contributing/index>` * :doc:`contributing to Django </internals/contributing/index>`
Contributions on any level -- developing code, writing Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed documentation or simply triaging tickets and helping to test proposed

View File

@ -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 requirements dictate. The latest information will always be available
on the Django project wiki: on the Django project wiki:
http://code.djangoproject.com/wiki/VersionOneRoadmap * http://code.djangoproject.com/wiki/VersionOneRoadmap
What you can do to help 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 you encounter. The Django ticket tracker is the central place to
search for open issues: 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 Please open new tickets if no existing ticket corresponds to a problem
you're running into. 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 toward the 1.0 release, takes place daily on the django-developers
mailing list: 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 ...and in the ``#django-dev`` IRC channel on ``irc.freenode.net``. If
you're interested in helping out with Django's development, feel free 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 Django's online documentation also includes pointers on how to
contribute to Django: contribute to Django:
:doc:`contributing to Django </internals/contributing/index>` * :doc:`contributing to Django </internals/contributing/index>`
Contributions on any level -- developing code, writing Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed documentation or simply triaging tickets and helping to test proposed

View File

@ -57,7 +57,7 @@ there.
In fact, new documentation is one of our favorite features of Django 1.0, so we 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: 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 The documentation has been greatly improved, cleaned up, and generally made
awesome. There's now dedicated search, indexes, and more. awesome. There's now dedicated search, indexes, and more.

View File

@ -663,7 +663,7 @@ Manually managing a user's password
.. function:: is_password_usable() .. function:: is_password_usable()
.. versionadded:: 1.4 .. versionadded:: 1.4
Checks if the given string is a hashed password that has a chance Checks if the given string is a hashed password that has a chance
of being verified against :func:`django.contrib.auth.utils.check_password`. of being verified against :func:`django.contrib.auth.utils.check_password`.

View File

@ -420,6 +420,8 @@ With this name value, the template would be rendered as::
Similarly, what if the name contained a ``'<'`` symbol, like this? Similarly, what if the name contained a ``'<'`` symbol, like this?
.. code-block:: html
<b>username <b>username
That would result in a rendered template like this:: That would result in a rendered template like this::