#25082 closed Cleanup/optimization (fixed)
Document where to register system checks
| Reported by: | Johannes Maron | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | 1.8 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
The documentation for the system check framework doesn't say where to add the checks. Nor does the the topic guide.
Should it be in the __init__.py or apps.py?
I tested that it does not work to just put it into any file. As the file needs to be loaded by the app loader to register the check functions.
I guess more detail to regarding this topic would be helpful, as the refactoring in 1.8 is really cool and should allow people to write more checks for their 3rd party apps.
Cheers,
Joe
Attachments (1)
Change History (5)
comment:1 by , 9 years ago
| Has patch: | set |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
by , 9 years ago
| Attachment: | 25082.diff added |
|---|
comment:4 by , 9 years ago
| Summary: | System check framework missing implementation details → Document where to register system checks |
|---|
Note:
See TracTickets
for help on using tickets.
How does the attached patch look?