#25174: System Check documentation lacking location
-------------------------------+--------------------------------------
Reporter: jrabbit | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Comment (by bmispelon):
The "Registering and labeling checks" section has the right information
indeed but it's not that obvious that you should read it.
I think the problem is the reference documentation of `CheckMessage` that
sits between the code example that uses `@register` without telling you
where the code should live, and the paragraph that suggests you to put the
code in an `AppConfig.ready()` method.
Personally, it made me switch between the "read as text, from top to
bottom" mode (ie "topic-style" documentation) to the "hop around trying to
find the info I'm looking for" mode (ie "reference-style" documentation).
Could we maybe move the bulk of the reference documentation for
`CheckMessage` into the `/ref/` documentation section?
--
Ticket URL: <https://code.djangoproject.com/ticket/25174#comment:3>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/065.00f95973b4db7418a10539fdfa804f85%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
