Browse Source

Documented AppRegistryNotReady.

Aymeric Augustin 8 years ago
parent
commit
5d35181de4
2 changed files with 14 additions and 3 deletions
  1. 5 3
      docs/ref/applications.txt
  2. 9 0
      docs/ref/exceptions.txt

+ 5 - 3
docs/ref/applications.txt

@@ -347,6 +347,8 @@ Application registry
     :exc:`ValueError` when called with a single argument that doesn't contain
     exactly one dot.
 
+.. _app-loading-process:
+
 Initialization process
 ======================
 
@@ -425,9 +427,9 @@ Troubleshooting
 
 Here are some common problems that you may encounter during initialization:
 
-* ``AppRegistryNotReady`` This happens when importing an application
-  configuration or a models module triggers code that depends on the app
-  registry.
+* :class:`~django.core.exceptions.AppRegistryNotReady`: This happens when
+  importing an application configuration or a models module triggers code that
+  depends on the app registry.
 
   For example, :func:`~django.utils.translation.ugettext()` uses the app
   registry to look up translation catalogs in applications. To translate at

+ 9 - 0
docs/ref/exceptions.txt

@@ -12,6 +12,15 @@ Django Core Exceptions
 
 Django core exception classes are defined in ``django.core.exceptions``.
 
+``AppRegistryNotReady``
+-----------------------
+
+.. exception:: AppRegistryNotReady
+
+    This exception is raised when attempting to use models before the :ref:`app
+    loading process <app-loading-process>`, which initializes the ORM, is
+    complete.
+
 ``ObjectDoesNotExist``
 ----------------------