Commit Graph

63 Commits

Author SHA1 Message Date
Mariusz Felisiak 3930ec1bf2
Fixed #31062 -- Doc'd asgi.py in tutorials and project templates. 2019-12-05 08:38:39 +01:00
Tobias Kunze 4a954cfd11 Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:

- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous

Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
2019-09-06 13:27:46 +02:00
Ali Mirlou 33b9b23bbb Fixed typo in docs/ref/applications.txt. 2019-08-23 08:48:26 +02:00
François Freitag 9b15ff08ba Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
Tim Graham cfff2af02b Fixed #27857 -- Dropped support for Python 3.4. 2017-09-25 17:11:03 -04:00
Tim Graham 5446b72003 Removed versionadded/changed annotations for 1.11. 2017-09-22 12:51:18 -04:00
Claude Paroz c651331b34 Converted usage of ugettext* functions to their gettext* aliases
Thanks Tim Graham for the review.
2017-02-07 09:04:04 +01:00
Tim Graham d170c63351 Refs #23919 -- Removed misc references to Python 2. 2017-01-21 20:02:00 -05:00
Tim Graham f6acd1d271 Refs #23919 -- Removed Python 2 notes in docs. 2017-01-18 11:51:29 -05:00
Tim Graham e27e4c0339 Removed versionadded/changed annotations for 1.10. 2017-01-17 20:52:05 -05:00
Aymeric Augustin cb7bbf97a7
Fixed #25966 -- Made get_user_model() work at import time.
This makes it equivalent to: `from django.contrib.auth.models import User`.

Thanks Aymeric Augustin for the initial patch and Tim Graham for the
review.
2016-11-25 14:15:49 +01:00
Aymeric Augustin 625cd5bcb3 Added require_ready argument to get_model methods.
This allows bringing back the behavior of Django < 1.7.

Also fixed the check for the app registry being ready in
AppConfig.get_model(s), which was inconsistent with the equivalent check in
Apps.get_model(s). That part is a backwards-incompatible change.
2016-10-28 19:08:57 -04:00
Aymeric Augustin efcb7e1ebf Modified readiness check in AppConfig.get_model(s).
It was inconsistent with the equivalent check in Apps.get_model(s)
because I made incorrect assumptions when I wrote that code and
needlessly complicated readiness checks.

This is a backwards-incompatible change.
2016-10-28 18:42:29 -04:00
Tim Graham e261337eea Fixed docs typos in lines ending with a dash. 2016-10-06 11:01:20 -04:00
Aymeric Augustin 5d35181de4 Documented AppRegistryNotReady. 2016-10-06 10:21:57 -04:00
Kevin Christopher Henry ff445f4c19 Fixed #26616 -- Clarified model usage in AppConfig.ready(). 2016-08-17 10:34:51 -04:00
Tim Graham 6b83f61e72 Fixed #27050 -- Corrected django.setup()'s parameter name in docs. 2016-08-11 07:01:55 -04:00
Florian Apolloner 9baf692a58 Fixed #26601 -- Improved middleware per DEP 0005.
Thanks Tim Graham for polishing the patch, updating the tests, and
writing documentation. Thanks Carl Meyer for shepherding the DEP.
2016-05-17 07:22:22 -04:00
Tim Graham 1f8cfcf3b4 Fixed #26278 -- Clarified apps.ready docs. 2016-02-25 08:55:10 -05:00
Blake Griffith 5fdbd9e36c Changed gypsy to manouche in docs and tests.
"Gypsy" is considered a slur by the Romani people whom it refers to.
"manouche jazz" is used in place of "gypsy jazz" and is an accepted
term for the same genre of music.
2016-02-03 09:45:30 -05:00
Tim Graham b07f91600d Fixed #26032 -- Moved "project root directory" to a separate paragraph. 2016-01-04 10:52:20 -05:00
Tim Graham e051930123 Fixed #25748 -- Added clarification on projects vs. applications.
Thanks Thomas Güttler for motivating this addition.
2015-12-30 17:46:53 -05:00
Tim Graham 6258e16335 Refs #24971, #25356 -- Clarified how apps.py works in 1.9 release notes. 2015-11-17 19:32:32 -05:00
Claude Paroz 7d81ee6efc Fixed #16734 -- Set script prefix even outside of requests
Thanks Tim Graham for the review.
2015-10-29 20:12:38 +01:00
Aymeric Augustin 94a36cfd8c Recommended against default_app_config.
Most likely this is a losing fight -- people seem to love this small
convention -- but at least the reasons for avoiding it will be
documented.

Refs #25356.
2015-09-22 08:31:50 +02:00
Tim Graham e7e8d30cae Refs #25381 -- Clarified that AppConfig model methods search only the current app. 2015-09-11 14:07:12 -04:00
Tim Graham 862de0b254 Fixed #25356 -- Removed default_app_config from startapp template.
Also discouraged its use outside the intended use case.
2015-09-07 15:23:11 -04:00
Floris den Hengst e42a720ba2 Fixed typos and updated spelling wordlist. 2015-03-07 17:59:03 +01:00
Tim Graham c79faae761 Removed versionadded/changed notes for 1.7. 2015-02-01 21:02:40 -05:00
Peter Inglesby 0fde2ca036 Fixed typo in docs/ref/applications.txt. 2014-12-06 09:22:46 -05:00
Aymeric Augustin a764a9ccff Checked more precisely whether the app registry is ready.
Accounted for the three stages of population: app configs, models,
ready() methods of app configs.
2014-07-12 18:49:37 +02:00
Claude Paroz 9618d68b34 Fixed #8033 -- Explained app registry error during translation setup
Thanks Tim Graham and Aymeric Augustin for the review.
2014-06-23 09:31:45 +02:00
Claude Paroz b8fc167b32 Fixed #22688 -- Documented ready() may be called more than once 2014-05-24 15:58:57 +02:00
Aymeric Augustin 58ed387db3 Documented django.setup().
Thanks Eric Holscher and Tim Graham for the review.
2014-04-26 20:13:59 +02:00
Claude Paroz 680a0f08b1 Updated doc links to point to Python 3 documentation 2014-04-26 16:02:53 +02:00
Aymeric Augustin 0315f01087 Fixed a confusing heading in applications docs.
Refs #22422.
2014-04-25 17:39:49 +02:00
Víðir Valberg Guðmundsson deb561bbe2 Fixed #22422 -- Moved information about the application loading process to refs/applications.txt. 2014-04-25 10:12:31 -04:00
Aymeric Augustin bbe818b23c Changed paths in docs that referred to Python 2. 2014-04-20 08:34:01 +02:00
Aymeric Augustin 3315535ae8 Fixed an example to match the code. 2014-03-09 21:20:34 +01:00
Tim Graham 1f5f015c32 Fixed spelling mistakes in docs. 2014-02-28 21:03:46 -05:00
Tim Graham 55fb162588 Fixed #22028 -- Documented that database signals aren't emitted for apps that laack a models module.
Thanks un33k for the suggestion and donjpacheco for the draft patch.
2014-02-28 09:22:33 -05:00
Zbigniew Siciarz 94b5bc361a Fixed #22002 -- Documented avoiding database interaction in AppConfig.ready().
Thanks Marc Tamlyn for the suggestion.
2014-02-15 13:50:31 -05:00
Simon Meers 007c5cd367 Updated docs that misreported django.apps.apps.ready as being a method. 2014-02-14 12:50:27 +11:00
Aymeric Augustin ab2f21080d Added a note about a possible name clash.
Thanks Russell for the advice.
2014-02-02 15:31:34 +01:00
Carl Meyer 88a2d39159 Fixed #21874 -- Require Django applications to have a filesystem path.
Wherever possible this filesystem path is derived automatically from the app
module's ``__path__`` and ``__file__`` attributes (this avoids any
backwards-compatibility problems).

AppConfig allows specifying an app's filesystem location explicitly, which
overrides all autodetection based on ``__path__`` and ``__file__``. This
permits Django to support any type of module as an app (namespace packages,
fake modules, modules loaded by other hypothetical non-filesystem module
loaders), as long as the app is configured with an explicit filesystem path.

Thanks Aymeric for review and discussion.
2014-01-27 15:34:22 -07:00
Aymeric Augustin 3c47786cb9 Fixed #21702 -- get_model('app_label.ModelName').
Also added tests for get_model.
2014-01-26 13:01:09 +01:00
Carl Meyer 8bc3780b67 Docs correction: apps loaded from eggs do not have appconfig.path None. 2014-01-25 20:56:36 -07:00
Carl Meyer 966b186981 Fixed #17304 -- Allow single-path and configured-path namespace packages as apps.
Also document the conditions under which a namespace package may or may not be
a Django app, and raise a clearer error message in those cases where it may not
be.

Thanks Aymeric for review and consultation.
2014-01-25 19:37:05 -07:00
Aymeric Augustin 2ff93e027c Fixed #21829 -- Added default AppConfigs.
Thanks Russell for the report, Marc for the initial patch, Carl for the
final review, and everyone who contributed to the design discussion.
2014-01-25 10:41:56 +01:00
Aymeric Augustin 3326a412cc Deprecated importing a model before loading its application.
Refs #21719, #21680.
2014-01-10 23:43:10 +01:00