[Django] #25174: System Check documentation lacking location

[Django]

#25174: System Check documentation lacking location
-------------------------------+--------------------
Reporter: jrabbit | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
https://docs.djangoproject.com/en/1.8/topics/checks/ doesn't say where
django looks for these checks... it looks like checks.py is the right
answer. but maybe also checks/

--
Ticket URL: <https://code.djangoproject.com/ticket/25174>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#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
-------------------------------+--------------------------------------
Changes (by jrabbit):

* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0

Post by Django
https://docs.djangoproject.com/en/1.8/topics/checks/ doesn't say where
django looks for these checks... it looks like checks.py is the right
answer. but maybe also checks/

New description:

https://docs.djangoproject.com/en/1.8/topics/checks/ doesn't say where
django looks for these checks... it looks like checks.py is the right
answer.

edit: So It appears that you need to hook the checks into django yourself?
(e.g. via Appconfig) This seems like a high bar of entry but it needs to
be documented better

--

--
Ticket URL: <https://code.djangoproject.com/ticket/25174#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#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 timgraham):

I think it's documented pretty well in
[https://docs.djangoproject.com/en/1.8/topics/checks/#registering-and-
labeling-checks Registering and labeling checks], but feel free to suggest
a patch if something is unclear.

--
Ticket URL: <https://code.djangoproject.com/ticket/25174#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#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.

[Django]

#25174: Move some details of CheckMessage to the reference guide.
--------------------------------------+------------------------------------
Reporter: jrabbit | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by timgraham):

* has_patch: 0 => 1
* stage: Unreviewed => Accepted
* type: Uncategorized => Cleanup/optimization


Comment:

[https://github.com/django/django/pull/5057 Proposal]

--
Ticket URL: <https://code.djangoproject.com/ticket/25174#comment:4>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#25174: Move some details of CheckMessage to the reference guide.
--------------------------------------+------------------------------------
Reporter: jrabbit | Owner: nobody
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham <timograham@…>):

* status: new => closed
* resolution: => fixed


Comment:

In [changeset:"faa2a0f662ed6fe0b90d10e98cc8ee3795d9307c" faa2a0f]:
{{{
#!CommitTicketReference repository=""
revision="faa2a0f662ed6fe0b90d10e98cc8ee3795d9307c"
Fixed #25174 -- Moved some details of CheckMessage to the reference guide.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/25174#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#25174: Move some details of CheckMessage to the reference guide.
--------------------------------------+------------------------------------
Reporter: jrabbit | Owner: nobody
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by Tim Graham <timograham@…>):

In [changeset:"386a6dc3d76fe01df1929503b00755bfce987b32" 386a6dc3]:
{{{
#!CommitTicketReference repository=""
revision="386a6dc3d76fe01df1929503b00755bfce987b32"
[1.8.x] Fixed #25174 -- Moved some details of CheckMessage to the
reference guide.

Backport of faa2a0f662ed6fe0b90d10e98cc8ee3795d9307c from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/25174#comment:6>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.