Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#23974 closed Cleanup/optimization (fixed)

Ambiguous description of save option of FileField.save() method

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

Description

Here:

https://docs.djangoproject.com/en/dev/ref/models/fields/#django.db.models.FileField

The FileField.save() method's save argument is described thusly:

"The optional save argument controls whether or not the instance is saved after the file has been altered. Defaults to True."

It's not clear what instance is being referred to here: is it the instance of FileField (which gramatically appears to be the case) or the instance of the model that has the FileField (which I think is the case, and makes more sense).

Note that in other places on this page, the field itself is referred to as an instance.

It would be better if this said

"The optional save argument controls whether or not the model instance is saved after the file associated with this FileField has been altered. Defaults to True."

Change History (3)

comment:1 by Tim Graham <timograham@…>, 10 years ago

Resolution: fixed
Status: newclosed

In 1aa41dd000e0779c8b1de1f8e7aa4a0f2f752655:

Fixed #23974 -- Clarified wording of FileField.save/delete save parameter.

Thanks GreenAsJade.

comment:2 by Tim Graham <timograham@…>, 10 years ago

In 6022da4f48a1c3fd019aac52b3fe9b804b1746f9:

[1.7.x] Fixed #23974 -- Clarified wording of FileField.save/delete save parameter.

Thanks GreenAsJade.

Backport of 1aa41dd000e0779c8b1de1f8e7aa4a0f2f752655 from master

comment:3 by Tim Graham <timograham@…>, 10 years ago

In 5fb7086b6b4c0129c57ea5928fd91d272f3e5858:

[1.6.x] Fixed #23974 -- Clarified wording of FileField.save/delete save parameter.

Thanks GreenAsJade.

Backport of 1aa41dd000e0779c8b1de1f8e7aa4a0f2f752655 from master

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