diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 9514153e94..6d8ff36835 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -850,10 +850,9 @@ details on these changes. used instead. * The ``django.test.simple.DjangoTestRunner`` will be removed. - Instead use a unittest-native class. The features of the + Instead use a ``unittest``-native class. The features of the ``django.test.simple.DjangoTestRunner`` (including fail-fast and - Ctrl-C test termination) can currently be provided by the unittest-native - :class:`~unittest.TextTestRunner`. + Ctrl-C test termination) can be provided by :class:`unittest.TextTestRunner`. * The undocumented function ``django.contrib.formtools.utils.security_hash`` will be removed, diff --git a/docs/intro/tutorial05.txt b/docs/intro/tutorial05.txt index 59fea496ca..c6c5e2900d 100644 --- a/docs/intro/tutorial05.txt +++ b/docs/intro/tutorial05.txt @@ -441,12 +441,12 @@ is, earlier than or equal to - ``timezone.now``. Testing our new view -------------------- -Now you can satisfy yourself that this behaves as expected by firing up the -runserver, loading the site in your browser, creating ``Questions`` with dates -in the past and future, and checking that only those that have been published -are listed. You don't want to have to do that *every single time you make any -change that might affect this* - so let's also create a test, based on our -:djadmin:`shell` session above. +Now you can satisfy yourself that this behaves as expected by firing up +``runserver``, loading the site in your browser, creating ``Questions`` with +dates in the past and future, and checking that only those that have been +published are listed. You don't want to have to do that *every single time you +make any change that might affect this* - so let's also create a test, based on +our :djadmin:`shell` session above. Add the following to ``polls/tests.py``: diff --git a/docs/releases/1.0-porting-guide.txt b/docs/releases/1.0-porting-guide.txt index 72f01495a5..03673e1772 100644 --- a/docs/releases/1.0-porting-guide.txt +++ b/docs/releases/1.0-porting-guide.txt @@ -401,8 +401,8 @@ Template tags :ttag:`spaceless` tag ~~~~~~~~~~~~~~~~~~~~~ -The spaceless template tag now removes *all* spaces between HTML tags, instead -of preserving a single space. +The ``spaceless`` template tag now removes *all* spaces between HTML tags, +instead of preserving a single space. Local flavors ------------- diff --git a/docs/releases/1.3.txt b/docs/releases/1.3.txt index 541211509d..ec746418b0 100644 --- a/docs/releases/1.3.txt +++ b/docs/releases/1.3.txt @@ -107,20 +107,20 @@ See the :doc:`reference documentation of the app ` for more details or learn how to :doc:`manage static files `. -unittest2 support ------------------ +``unittest2`` support +---------------------- Python 2.7 introduced some major changes to the ``unittest`` library, adding some extremely useful features. To ensure that every Django project can benefit from these new features, Django ships with a copy -of unittest2_, a copy of the Python 2.7 unittest library, backported +of unittest2_, a copy of the Python 2.7 ``unittest`` library, backported for Python 2.4 compatibility. To access this library, Django provides the ``django.utils.unittest`` module alias. If you are using Python 2.7, or you have installed ``unittest2`` locally, Django will map the alias to the installed -version of the unittest library. Otherwise, Django will use its own -bundled version of unittest2. +version of the ``unittest`` library. Otherwise, Django will use its own +bundled version of ``unittest2``. To take advantage of this alias, simply use:: @@ -130,8 +130,8 @@ wherever you would have historically used:: import unittest -If you want to continue to use the base unittest library, you can -- -you just won't get any of the nice new unittest2 features. +If you want to continue to use the base ``unittest`` library, you can -- +you just won't get any of the nice new ``unittest2`` features. .. _unittest2: https://pypi.org/project/unittest2/ @@ -313,7 +313,7 @@ requests. These include: :class:`~django.template.RequestContext` by default. * Support for combining :class:`F expressions ` - with timedelta values when retrieving or updating database values. + with ``timedelta`` values when retrieving or updating database values. .. _HTTPOnly: https://www.owasp.org/index.php/HTTPOnly @@ -712,7 +712,7 @@ list, even if it has only a single element or no elements. ``DjangoTestRunner`` -------------------- -As a result of the introduction of support for unittest2, the features +As a result of the introduction of support for ``unittest2``, the features of ``django.test.simple.DjangoTestRunner`` (including fail-fast and Ctrl-C test termination) have been made redundant. In view of this redundancy, ``DjangoTestRunner`` has been turned into an empty placeholder diff --git a/docs/releases/1.4.txt b/docs/releases/1.4.txt index 13cff1f0b3..95f1df2e63 100644 --- a/docs/releases/1.4.txt +++ b/docs/releases/1.4.txt @@ -213,7 +213,7 @@ can be used for :doc:`deploying with WSGI app servers`. The :djadmin:`built-in development server` now supports using an -externally-defined WSGI callable, which makes it possible to run runserver +externally-defined WSGI callable, which makes it possible to run ``runserver`` with the same WSGI configuration that is used for deployment. The new :setting:`WSGI_APPLICATION` setting lets you configure which WSGI callable :djadmin:`runserver` uses. diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt index af8de1ea12..57f14d606a 100644 --- a/docs/releases/1.5.txt +++ b/docs/releases/1.5.txt @@ -260,8 +260,8 @@ Django 1.5 also includes several smaller improvements worth noting: ``self.stderr.write('error')`` (see the note on :ref:`management commands output `). -* The dumpdata management command outputs one row at a time, preventing - out-of-memory errors when dumping large datasets. +* The :djadmin:`dumpdata` management command outputs one row at a time, + preventing out-of-memory errors when dumping large datasets. * In the localflavor for Canada, "pq" was added to the acceptable codes for Quebec. It's an old abbreviation. @@ -602,7 +602,7 @@ Ordering of tests In order to make sure all ``TestCase`` code starts with a clean database, tests are now executed in the following order: -* First, all unittests (including :class:`unittest.TestCase`, +* First, all unit tests (including :class:`unittest.TestCase`, :class:`~django.test.SimpleTestCase`, :class:`~django.test.TestCase` and :class:`~django.test.TransactionTestCase`) are run with no particular ordering guaranteed nor enforced among them. diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt index 00d099b025..53bae5b049 100644 --- a/docs/releases/1.6.txt +++ b/docs/releases/1.6.txt @@ -415,8 +415,8 @@ be removed. New test runner --------------- -In order to maintain greater consistency with Python's unittest module, the new -test runner (``django.test.runner.DiscoverRunner``) does not automatically +In order to maintain greater consistency with Python's ``unittest`` module, the +new test runner (``django.test.runner.DiscoverRunner``) does not automatically support some types of tests that were supported by the previous runner: * Tests in ``models.py`` and ``tests/__init__.py`` files will no longer be @@ -430,7 +430,7 @@ Django bundles a modified version of the :mod:`doctest` module from the Python standard library (in ``django.test._doctest``) and includes some additional doctest utilities. These utilities are deprecated and will be removed in Django 1.8; doctest suites should be updated to work with the standard library's -doctest module (or converted to unittest-compatible tests). +doctest module (or converted to ``unittest``-compatible tests). If you wish to delay updates to your test suite, you can set your :setting:`TEST_RUNNER` setting to ``django.test.simple.DjangoTestSuiteRunner`` diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index 6dde2732af..33d3ad2dac 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -2,7 +2,6 @@ accessor accessors Aceh -addslashes admin admindocs admins @@ -52,8 +51,6 @@ backports backtraces balancer basename -bbcontains -bboverlaps Bcc BCC'ed bcrypt @@ -66,7 +63,6 @@ Biggs bitwise Bjørn blazingly -blocktrans blog blogs boilerplatish @@ -91,12 +87,10 @@ bytestrings cacheable callables camelCase -capfirst cardinality centric centroid changelist -changepassword changeset charset checkbox @@ -105,7 +99,6 @@ checkin checksum checksums clearable -clearsessions clickable clickjacking cms @@ -114,22 +107,15 @@ codec codename codenamed coercible -collectstatic commenters committer committers -compilemessages concat conf config -ContentType contenttypes contrib covariance -coveredby -createcachetable -createdb -createsuperuser criticals cron crontab @@ -154,8 +140,6 @@ dataset datasets datatype datetimes -dbshell -de Debian declaratively deconstruct @@ -177,19 +161,14 @@ dev dict dictConfig dicts -dictsort -dictsortreversed diff -diffsettings Dimensionally dimensioned dirmod discoverable Disqus distro -divisibleby Django -djangojs djangoproject Django's dm @@ -205,17 +184,13 @@ drilldown dropdown dropdowns drupal -dumpdata Dunck -dwithin editability elidable encodings Endian -endswith Enero environ -escapejs esque Ess ETag @@ -223,7 +198,6 @@ ETags exe extensibility Facebook -facto fallback fallbacks faq @@ -233,17 +207,13 @@ fieldset fieldsets filename filenames -filesizeformat filesystem filesystems -findstatic Firesheep -firstof fk flatpage flatpages Flatpages -floatformat followup fooapp formatters @@ -303,12 +273,8 @@ html http https hyperlinks -icontains ie -iendswith ies -iexact -ifchanged iframe inbox incrementing @@ -319,31 +285,22 @@ ini init inline inlines -inspectdb Instagram instantiation -intcomma interdependencies internet interoperability intranet -intword ip ipsum IPv IPython irc -iregex -iriencode ise -isempty -isnull iso -istartswith iterable iterables iteratively -itunes iTunes ize JavaScript @@ -362,19 +319,13 @@ Kyngesburye latin lawrence lexer -lhs lifecycle lifecycles linearize -linebreaks -linebreaksbr -linenumbers linestring linework linter Livni -ljust -loaddata localflavor localhost localizable @@ -395,8 +346,6 @@ lte Luhn macOS Magee -makemessages -makemigrations Mako manouche Marczewski @@ -452,8 +401,6 @@ namespaces namespacing Nanggroe natively -naturalday -naturaltime nd needsinfo německy @@ -467,7 +414,6 @@ OAuth offline OGC OGR -ogrinspect oldforms online ons @@ -542,7 +488,6 @@ preprocessed preprocesses preprocessing programmatically -projectname proxied proxying pseudocode @@ -599,7 +544,6 @@ reinstall releaser releasers reloader -removetags renderer renderers repo @@ -612,14 +556,10 @@ reStructuredText reusability revalidate reverter -rhs -rjust roadmap Roald rss -runserver runtime -safeseq Sandvik savepoint savepoints @@ -630,22 +570,18 @@ screencast screencasts screenshot screenshots -sdist semimajor semiminor -sendtestemail serializability serializable serializer serializers -servlet sessionid setuptools sha shapefile shapefiles sharding -showmigrations sid simultaneously sitemap @@ -654,27 +590,18 @@ sitewide slashdot sliceable slippy -slugify SMTP solaris Solr sortable -spaceless spam spammers spatialite Springmeyer SQL -sqlflush -sqlmigrate -sqlsequencereset -squashmigrations ssi SSL stacktrace -startapp -startproject -startswith startup stateful staticfile @@ -683,8 +610,6 @@ stderr stdlib stdout storages -stringformat -striptags stylesheet stylesheets subclass @@ -708,7 +633,6 @@ subprocesses subqueries subquery subselect -substr substring subtemplate subtemplates @@ -736,22 +660,18 @@ tarballs teardown templating testcase -testserver textarea th that'll Thejaswi This'll -timedelta timeframe timeline timelines timesaving -timesince timestamp timestamped timestamps -timeuntil timezones titlecase tmp @@ -770,8 +690,6 @@ triagers triaging trigram trigrams -truncatechars -truncatewords tuple tuples tv @@ -802,11 +720,8 @@ unhashable unicode uninstall uninstalling -uninstalls unioning uniterated -unittest -unittests unlocalize unlocalized unmaintained @@ -831,11 +746,7 @@ untrusted unvalidated uppercased url -urlencode -urlize -urlizetrunc urljoins -urllib urlpatterns urls useable @@ -863,21 +774,17 @@ virtualenv virtualenvs virtualized Weblog -whatsnext whitelist whitelisted whitespace whitespaces whizbang -widthratio wiki wikipedia wildcard wildcards Willison wontfix -wordcount -wordwrap workflow worksforme wrappable @@ -887,5 +794,4 @@ xe xgettext XSS xxxxx -yesno Zope diff --git a/docs/topics/i18n/translation.txt b/docs/topics/i18n/translation.txt index 34313034c8..60e73fa779 100644 --- a/docs/topics/i18n/translation.txt +++ b/docs/topics/i18n/translation.txt @@ -663,7 +663,7 @@ You can use multiple expressions inside a single ``blocktrans`` tag:: Other block tags (for example ``{% for %}`` or ``{% if %}``) are not allowed inside a ``blocktrans`` tag. -If resolving one of the block arguments fails, blocktrans will fall back to +If resolving one of the block arguments fails, ``blocktrans`` will fall back to the default language by deactivating the currently active language temporarily with the :func:`~django.utils.translation.deactivate_all` function. @@ -1525,7 +1525,7 @@ multiple times:: When :ref:`creating message files from JavaScript source code ` you need to use the special - 'djangojs' domain, **not** ``-e js``. + ``djangojs`` domain, **not** ``-e js``. .. admonition:: Using Jinja2 templates? @@ -1876,7 +1876,7 @@ For example:: translation.activate(cur_language) return text -Calling this function with the value 'de' will give you ``"Willkommen"``, +Calling this function with the value ``'de'`` will give you ``"Willkommen"``, regardless of :setting:`LANGUAGE_CODE` and language set by middleware. Functions of particular interest are @@ -2023,8 +2023,8 @@ Notes: ] This example restricts languages that are available for automatic - selection to German and English (and any sublanguage, like de-ch or - en-us). + selection to German and English (and any sublanguage, like ``de-ch`` or + ``en-us``). * If you define a custom :setting:`LANGUAGES` setting, as explained in the previous bullet, you can mark the language names as translation strings diff --git a/docs/topics/migrations.txt b/docs/topics/migrations.txt index e3f7513433..4fc1fdd47e 100644 --- a/docs/topics/migrations.txt +++ b/docs/topics/migrations.txt @@ -627,9 +627,10 @@ or with a ``CircularDependencyError``, in which case you can manually resolve it To manually resolve a ``CircularDependencyError``, break out one of the ForeignKeys in the circular dependency loop into a separate migration, and move the dependency on the other app with it. If you're unsure, -see how makemigrations deals with the problem when asked to create brand -new migrations from your models. In a future release of Django, squashmigrations -will be updated to attempt to resolve these errors itself. +see how :djadmin:`makemigrations` deals with the problem when asked to create +brand new migrations from your models. In a future release of Django, +:djadmin:`squashmigrations` will be updated to attempt to resolve these errors +itself. Once you've squashed your migration, you should then commit it alongside the migrations it replaces and distribute this change to all running instances diff --git a/docs/topics/serialization.txt b/docs/topics/serialization.txt index 433fb23718..70c023fe70 100644 --- a/docs/topics/serialization.txt +++ b/docs/topics/serialization.txt @@ -180,7 +180,7 @@ The basic XML serialization format is quite simple:: -The whole collection of objects that is either serialized or de-serialized is +The whole collection of objects that is either serialized or deserialized is represented by a ````-tag which contains multiple ````-elements. Each such object has two attributes: "pk" and "model", the latter being represented by the name of the app ("sessions") and the @@ -198,11 +198,11 @@ Foreign keys and other relational fields are treated a little bit differently:: -In this example we specify that the auth.Permission object with the PK 27 has -a foreign key to the contenttypes.ContentType instance with the PK 9. +In this example we specify that the ``auth.Permission`` object with the PK 27 +has a foreign key to the ``contenttypes.ContentType`` instance with the PK 9. ManyToMany-relations are exported for the model that binds them. For instance, -the auth.User model has such a relation to the auth.Permission model:: +the ``auth.User`` model has such a relation to the ``auth.Permission`` model::