From 510e545776468ee0d546c1d57ca668a53d261ca6 Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Sun, 1 Jul 2007 01:00:23 +0000 Subject: [PATCH] Fixed #4690 -- Fixed a bunch of ReST errors in docs. Thanks, Paul B. git-svn-id: http://code.djangoproject.com/svn/django/trunk@5571 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/authentication.txt | 2 +- docs/db-api.txt | 2 +- docs/django-admin.txt | 2 +- docs/legacy_databases.txt | 2 +- docs/release_notes_0.96.txt | 2 +- docs/serialization.txt | 4 ++-- docs/testing.txt | 8 ++++---- docs/tutorial01.txt | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/authentication.txt b/docs/authentication.txt index 5e5ecdf908..efe4d47513 100644 --- a/docs/authentication.txt +++ b/docs/authentication.txt @@ -461,7 +461,7 @@ block:: Other built-in views -------------------- -In addition to the `login` view, the authentication system includes a +In addition to the ``login`` view, the authentication system includes a few other useful built-in views: ``django.contrib.auth.views.logout`` diff --git a/docs/db-api.txt b/docs/db-api.txt index ab71e68774..a4b920fb33 100644 --- a/docs/db-api.txt +++ b/docs/db-api.txt @@ -1831,7 +1831,7 @@ use the default manager, or if you want to search a list of related objects, you can provide ``get_object_or_404()`` with a manager object instead. For example:: - # Get the author of blog instance `e` with a name of 'Fred' + # Get the author of blog instance e with a name of 'Fred' a = get_object_or_404(e.authors, name='Fred') # Use a custom manager 'recent_entries' in the search for an diff --git a/docs/django-admin.txt b/docs/django-admin.txt index d20db7edc9..75c2738543 100644 --- a/docs/django-admin.txt +++ b/docs/django-admin.txt @@ -513,7 +513,7 @@ Example usage:: Verbosity determines the amount of notification and debug information that will be printed to the console. '0' is no output, '1' is normal output, -and `2` is verbose output. +and ``2`` is verbose output. --adminmedia ------------ diff --git a/docs/legacy_databases.txt b/docs/legacy_databases.txt index ca3927e52f..b87a661f90 100644 --- a/docs/legacy_databases.txt +++ b/docs/legacy_databases.txt @@ -18,7 +18,7 @@ You'll need to tell Django what your database connection parameters are, and what the name of the database is. Do that by editing these settings in your `settings file`_: - * `DATABASE_NAME` + * `DATABASE_NAME`_ * `DATABASE_ENGINE`_ * `DATABASE_USER`_ * `DATABASE_PASSWORD`_ diff --git a/docs/release_notes_0.96.txt b/docs/release_notes_0.96.txt index f62780c6b2..4227de8155 100644 --- a/docs/release_notes_0.96.txt +++ b/docs/release_notes_0.96.txt @@ -28,7 +28,7 @@ The following changes may require you to update your code when you switch from Due to a bug in older versions of the ``MySQLdb`` Python module (which Django uses to connect to MySQL databases), Django's MySQL backend now -requires version 1.2.1p2 or higher of `MySQLdb`, and will raise +requires version 1.2.1p2 or higher of ``MySQLdb``, and will raise exceptions if you attempt to use an older version. If you're currently unable to upgrade your copy of ``MySQLdb`` to meet diff --git a/docs/serialization.txt b/docs/serialization.txt index 01afa2708c..fa9b4edd51 100644 --- a/docs/serialization.txt +++ b/docs/serialization.txt @@ -48,12 +48,12 @@ Subset of fields ~~~~~~~~~~~~~~~~ If you only want a subset of fields to be serialized, you can -specify a `fields` argument to the serializer:: +specify a ``fields`` argument to the serializer:: from django.core import serializers data = serializers.serialize('xml', SomeModel.objects.all(), fields=('name','size')) -In this example, only the `name` and `size` attributes of each model will +In this example, only the ``name`` and ``size`` attributes of each model will be serialized. .. note:: diff --git a/docs/testing.txt b/docs/testing.txt index 50c4ec3046..b326e0099d 100644 --- a/docs/testing.txt +++ b/docs/testing.txt @@ -253,8 +253,8 @@ can be invoked on the ``Client`` instance. f.close() will result in the evaluation of a POST request on ``/customers/wishes/``, - with a POST dictionary that contains `name`, `attachment` (containing the - file name), and `attachment_file` (containing the file data). Note that you + with a POST dictionary that contains ``name``, ``attachment`` (containing the + file name), and ``attachment_file`` (containing the file data). Note that you need to manually close the file after it has been provided to the POST. ``login(**credentials)`` @@ -660,8 +660,8 @@ arguments: tested. This is the same format returned by ``django.db.models.get_apps()`` Verbosity determines the amount of notification and debug information that - will be printed to the console; `0` is no output, `1` is normal output, - and `2` is verbose output. + will be printed to the console; ``0`` is no output, ``1`` is normal output, + and ``2`` is verbose output. This method should return the number of tests that failed. diff --git a/docs/tutorial01.txt b/docs/tutorial01.txt index d26f654f87..fdac9c554e 100644 --- a/docs/tutorial01.txt +++ b/docs/tutorial01.txt @@ -360,7 +360,7 @@ Note the following: quotes. The author of this tutorial runs PostgreSQL, so the example output is in PostgreSQL syntax. - * The `sql` command doesn't actually run the SQL in your database - it just + * The ``sql`` command doesn't actually run the SQL in your database - it just prints it to the screen so that you can see what SQL Django thinks is required. If you wanted to, you could copy and paste this SQL into your database prompt. However, as we will see shortly, Django provides an easier way of committing