Opened 10 years ago

Closed 9 years ago

#3972 closed (fixed)

Outdated newforms save_instance docstring

Reported by: anonymous Owned by: Adrian Holovaty
Component: Forms Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


I'm new but isn't the comment:

"Assumes form has a field for *every non-AutoField* database field in
instance. If commit=True, then the changes to instance will be
saved to the database. Returns instance.
" confusing if you exclude fields with the condition in the line below (or not f.e.)

if not f.editable or isinstance(f, models.AutoField) or not in clean_data:


Attachments (1)

save_instance_docstring.patch (700 bytes) - added by Chris Beaven 9 years ago.

Download all attachments as: .zip

Change History (4)

comment:1 Changed 10 years ago by Chris Beaven

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Summary: newforms save_instance __doc__ confusing?Outdated newforms save_instance docstring
Triage Stage: UnreviewedAccepted

Correct, it doesn't assume this any more. The docstring needs to be updated.

Changed 9 years ago by Chris Beaven

comment:2 Changed 9 years ago by Chris Beaven

Has patch: set
Triage Stage: AcceptedReady for checkin

comment:3 Changed 9 years ago by Malcolm Tredinnick

Resolution: fixed
Status: newclosed

(In [5471]) Fixed #3972 -- Updated docstring. Patch from SmileyChris.

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