Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#26278 closed Bug (fixed)

Misleading documentation of apps.ready condition

Reported by: Petr Dlouhý Owned by: nobody
Component: Documentation Version: 1.9
Severity: Normal Keywords: appconfig
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

From the discussion on django fieldsignals page it is clear, that the documentation about AppConfig.ready() and apps.ready variable could be quite misleading.

On https://docs.djangoproject.com/en/1.9/ref/applications/#django.apps.apps.ready in section about apps.ready is written:

Boolean attribute that is set to True when the registry is fully populated.

And in the section about AppConfig.ready():

It is called as soon as the registry is fully populated.

Which might lead to conclusion, that apps.ready variable is True in AppConfig.ready(), which is not true (as could be seen in Django code).

Change History (4)

comment:1 Changed 6 years ago by Tim Graham

Has patch: set
Triage Stage: UnreviewedAccepted

Is this better?

Boolean attribute that is set to ``True`` after the registry is fully
populated and all :meth:`AppConfig.ready` methods are called.

comment:2 Changed 6 years ago by Aymeric Augustin

Yes.

comment:3 Changed 6 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: newclosed

In 7f02c1e:

[1.9.x] Fixed #26278 -- Clarified apps.ready docs.

Backport of 1f8cfcf3b41bac0ec862f171e2efb51b35324045 from master

comment:4 Changed 6 years ago by Tim Graham <timograham@…>

In 1f8cfcf3:

Fixed #26278 -- Clarified apps.ready docs.

Note: See TracTickets for help on using tickets.
Back to Top