Code

Opened 7 years ago

Closed 7 years ago

#4737 closed (wontfix)

Split the model field options into those affecting the database and those affecting its appearance or validation.

Reported by: Lllama Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: models docs validation
Cc: Triage Stage: Design decision needed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: UI/UX:

Description

The attached documentation patch split the model field options into those affecting the model's representation in the database and those affecting its appearance or validation.

A slight confusion with 'blank' and 'null' meant that I was associating 'blank' with 'required'. This is a fair assumption for the majority of the time (admin app and forms do the same) but using the models in other scripts could cause some confusion when CharFields get created with empty strings by default.

Attachments (2)

diff.txt (3.7 KB) - added by Lllama 7 years ago.
Patch to docs for splitting model options into two categories
4737.patch (3.8 KB) - added by SmileyChris 7 years ago.
as a trac readable diff (and a couple of minor changes)

Download all attachments as: .zip

Change History (6)

Changed 7 years ago by Lllama

Patch to docs for splitting model options into two categories

Changed 7 years ago by SmileyChris

as a trac readable diff (and a couple of minor changes)

comment:1 Changed 7 years ago by SmileyChris

  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Design decision needed

comment:2 Changed 7 years ago by SmileyChris

  • Summary changed from Slight improvement to model documentation. to Split the model field options into those affecting the database and those affecting its appearance or validation.

comment:3 Changed 7 years ago by mtredinnick

  • Patch needs improvement set

I don't like this change. We currently have one alphabetised list of field options that the reader needs to scan. This would change that into two lists, which isn't an improvement. How about just adding a short sentence to each of the options that apply at the database level noting that fact?

comment:4 Changed 7 years ago by ubernostrum

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

Since the original point of this ticket has been vetoed, and since apparently nobody's interested enough to pick up Malcolm's suggestion, I'm going to close this.

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.