#15059: Additional Documentation for the objects in the admin templates
-------------------------------------+-------------------------------------
     Reporter:  mlakewood            |                    Owner:  nobody
         Type:  Bug                  |                   Status:  new
    Component:  Documentation        |                  Version:  1.2
     Severity:  Normal               |               Resolution:
     Keywords:  admin templates      |             Triage Stage:  Accepted
  override                           |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  0                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by Caio Ariede):

 * cc: Caio Ariede (added)


Comment:

 > Would a simple pointer at the code suffice?

 I really think that this deserves better documentation, specially because
 it's already been used by some pretty popular projects like django-
 grappelli, django-jet at al.

 I'd say having these documented will help us formalize that the context
 sent to admin templates are stable and any changes should be stated in
 release notes and docs.

 Perhaps we could add the context for each template list in
 [https://docs.djangoproject.com/en/dev/ref/contrib/admin/#templates-which-
 may-be-overridden-per-app-or-model Templates which may be overridden per
 app or model]?

 I'm not exactly sure about the formatting that could be used, but this is
 what I have in mind for now:

 * **change_list.html** with the following context:
   * **module_name**
   * **selection_note** - text containing count of selected records (eg. `0
 of %(cnt)s selected`)
   * **selection_note_all** - same as **selection_note** but with all
 records
   * **title** - title of the page
   * ...

-- 
Ticket URL: <https://code.djangoproject.com/ticket/15059#comment:6>
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/067.e39f1ded51ed8059fbd90d9eb393ed28%40djangoproject.com.

Reply via email to