Code

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#9931 closed (invalid)

outdated description in Django admin site documentation

Reported by: gaumann Owned by: nobody
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The second sentence in the Django admin site documentation (http://docs.djangoproject.com/en/dev/ref/contrib/admin/#ref-contrib-admin) begins: "It reads metadata in your model to provide a powerful and production-ready interface that ..." I am just learning Django but it seems to me that this describes the old admin approach and now it reads metadata primarily from an Admin class. If my understanding is correct this sentence should be modified to reflect the change in 1.0

Attachments (0)

Change History (4)

comment:1 Changed 5 years ago by brosner

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to invalid
  • Status changed from new to closed

That sentence is still valid in 1.0. The admin is still reading metadata (being fields for example) to construct an admin interface. An admin class is not required for the admin to work.

comment:2 Changed 5 years ago by gaumann

But the metadata is no longer in the model, now it is in a ModelAdmin class.

comment:3 follow-up: Changed 5 years ago by Alex

Data is still read from the Model itself, for example for the model the admin gets the types of fields, so it knows when to use the date time widget.

comment:4 in reply to: ↑ 3 Changed 5 years ago by gaumann

Replying to Alex:

Data is still read from the Model itself, for example for the model the admin gets the types of fields, so it knows when to use the date time widget.

I realise that it is reading some metadata from the model. However the way the documentation is written it is effectively saying it reads metadata only from the model. However in newforms it is reading metadata from both the ModelAdmin class that is registered with the model and the Model class. Hence I still think the documentation is confusing and it would be better to change it.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.