Opened 13 years ago
Closed 13 years ago
#17902 closed New feature (wontfix)
Help_text for models
| Reported by: | Berislav Lopac | Owned by: | nobody |
|---|---|---|---|
| Component: | Database layer (models, ORM) | Version: | 1.4-alpha-1 |
| Severity: | Normal | Keywords: | models help_text |
| Cc: | lemaire.adrien@… | Triage Stage: | Design decision needed |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
It would be useful if models would have a help_text attribute, similar to the one on fields. It would best be a Meta class attribute, but accessible globally from the model. It would be used by admin interface as well as ModelForm to show default information/instructions about the model.
I'd write that myself but I'm currently extremely short of time, so I'm putting it here for future reference and inspiration. Occasionally I have used the model's docstring for this purpose, but it's not as simple to internationalize.
Change History (2)
comment:1 by , 13 years ago
| Cc: | added |
|---|---|
| Easy pickings: | set |
| Triage Stage: | Unreviewed → Design decision needed |
comment:2 by , 13 years ago
| Resolution: | → wontfix |
|---|---|
| Status: | new → closed |
I'm afraid I don't see the need for this. As pointed out by @Fandekasp, there are existing mechanisms for documenting model classes; we don't need to invent a new one. help_text is required on fields for per-instance documentation of field usage; however, there is no analog for models that I can think of.
help_text attributes for models would be only useful for admins and developers. But aren't Model.unicode() and Model.doc() enough already for that ?