Opened 5 years ago

Closed 5 years ago

#17219 closed Cleanup/optimization (fixed)

Add a more precise description to some db fields.

Reported by: charettes Owned by: nobody
Component: Translations Version:
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no


Some IntegerField subclasses share the same description which render this attribute pretty useless in the end.

The same happens with SlugField which has the same description as the CharField and with FileField and ImageField.

Here's the github pull request
and the dynamic diff.

Is there a command to makemessages for the core? Does the .po changes must be included in this commit?

Attachments (1)

17219.diff (2.4 KB) - added by charettes 5 years ago.

Download all attachments as: .zip

Change History (6)

Changed 5 years ago by charettes

comment:1 Changed 5 years ago by charettes

  • Component changed from Uncategorized to Translations
  • Easy pickings set
  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Type changed from Uncategorized to Cleanup/optimization

comment:2 Changed 5 years ago by charettes

jezdez wrote:

I'm not sure what those new labels would help the user, to be honest. The implementation details of those fields should not be reflected on the front-end, IMO.

Actually the only place i found where it was used is in contrib.admindocs which exposes it to the frond-end.

comment:3 Changed 5 years ago by aaugustin

  • Triage Stage changed from Unreviewed to Accepted

I confirm that description is only used by the admindocs contrib app — at least, as far as I can tell. This app is targeted at developers, not end users.

comment:4 Changed 5 years ago by jezdez

  • Triage Stage changed from Accepted to Ready for checkin

comment:5 Changed 5 years ago by jezdez

  • Resolution set to fixed
  • Status changed from new to closed

In [17476]:

Fixed #17219 -- Updated model field descriptions to be more precise. Thanks, charettes.

Note: See TracTickets for help on using tickets.
Back to Top