Opened 12 months ago

Closed 12 months ago

Last modified 12 months ago

#36654 closed Cleanup/optimization (fixed)

Incorrect docstring in model _do_update

Reported by: Václav Řehák Owned by: Augusto Pontes
Component: Database layer (models, ORM) Version: 6.0
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

In 55a0073b3beb9de8f7c1f7c44a7d0bc10126c841 _do_update was changed not to return bool but a list of updated fileds but the docstring at
​https://github.com/django/django/blob/main/django/db/models/base.py#L1185 was not updated

Try to update the model. Return True if the model was updated (if an
update query was done and a matching row was found in the DB).

Change History (6)

comment:1 by Augusto Pontes, 12 months ago

Hi, so i analyzed the docstring at the {{ _do_update}}} method, can i give a suggestion of the correct docstring?

in reply to:  1 comment:2 by Clifford Gama, 12 months ago

Triage Stage: Unreviewed → Accepted

Replying to Augusto Pontes:

Hi, so i analyzed the docstring at the {{ _do_update}}} method, can i give a suggestion of the correct docstring?

Yes, feel free to submit a PR.

comment:3 by Augusto Pontes, 12 months ago

Has patch: set
Owner: set to Augusto Pontes
Status: new → assigned

comment:5 by GitHub <noreply@…>, 12 months ago

Resolution: → fixed
Status: assigned → closed

In 5d6c36d:

Fixed #36654 -- Corrected Model._do_update()'s docstring.

comment:6 by Jacob Walls, 12 months ago

Triage Stage: Accepted → Ready for checkin
Note: See TracTickets for help on using tickets.
Back to Top