Docs on ModelAdmin.form attribute need improvement
| Reported by: |
|
Owned by: |
nobody |
|
Component:
|
Documentation
|
Version:
|
dev
|
|
Severity:
|
|
Keywords:
|
|
|
Cc:
|
|
Triage Stage:
|
Accepted
|
|
Has patch:
|
yes
|
Needs documentation:
|
no
|
|
Needs tests:
|
no
|
Patch needs improvement:
|
no
|
|
Easy pickings:
|
no
|
UI/UX:
|
no
|
At the moment it is not really clear from the docs that you have to supply a subclass that already has a Meta class in it. From reading it I thought this would be added by the admin (as happens if you don't set the form attribute). This interpretation is also enforced by the lack of a Meta class in the validation example given later on. The attached patch fixes the example and tries to be a bit more explicit in the form attribute explanation.
(In [8395]) Fixed #8299 -- Clarified the ModelAdmin.form option. Also added an inner Meta class to the ModelForm example in adding custom validation to the admin. Thanks jarrow for the report and initial patch.