[Django] #36654: Incorrect docstring in model _do_update

[Django]

#36654: Incorrect docstring in model _do_update
-------------------------------------+-------------------------------------
Reporter: Václav Řehák | Type:
| Cleanup/optimization
Status: new | Component: Database
| layer (models, ORM)
Version: 6.0 | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
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).
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36654>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36654: Incorrect docstring in model _do_update
-------------------------------------+-------------------------------------

Reporter: Václav Řehák | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Database layer | Version: 6.0
(models, ORM) |
Severity: Normal | Resolution:

Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Augusto Pontes):

Hi, so i analyzed the docstring at the {{ _do_update}}} method, can i
give a suggestion of the correct docstring?
--
Ticket URL: <https://code.djangoproject.com/ticket/36654#comment:1>

[Django]

#36654: Incorrect docstring in model _do_update
-------------------------------------+-------------------------------------
Reporter: Václav Řehák | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Database layer | Version: 6.0
(models, ORM) |
Severity: Normal | Resolution:

Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Clifford Gama):

* stage: Unreviewed => Accepted

Comment:

Replying to [comment:1 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.
--
Ticket URL: <https://code.djangoproject.com/ticket/36654#comment:2>

[Django]

#36654: Incorrect docstring in model _do_update
-------------------------------------+-------------------------------------

Reporter: Václav Řehák | Owner: Augusto
Type: | Pontes
Cleanup/optimization | Status: assigned

Component: Database layer | Version: 6.0
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Augusto Pontes):

* has_patch: 0 => 1
* owner: (none) => Augusto Pontes
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36654#comment:3>

[Django]

#36654: Incorrect docstring in model _do_update
-------------------------------------+-------------------------------------
Reporter: Václav Řehák | Owner: Augusto
Type: | Pontes
Cleanup/optimization | Status: assigned
Component: Database layer | Version: 6.0
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Augusto Pontes):

https://github.com/django/django/pull/19949
--
Ticket URL: <https://code.djangoproject.com/ticket/36654#comment:4>

[Django]

#36654: Incorrect docstring in model _do_update
-------------------------------------+-------------------------------------
Reporter: Václav Řehák | Owner: Augusto
Type: | Pontes

Cleanup/optimization | Status: closed

Component: Database layer | Version: 6.0
(models, ORM) |

Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by GitHub <noreply@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"5d6c36d8349be277bbfab282a1b4aa98296d4842" 5d6c36d]:
{{{#!CommitTicketReference repository=""
revision="5d6c36d8349be277bbfab282a1b4aa98296d4842"
Fixed #36654 -- Corrected Model._do_update()'s docstring.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36654#comment:5>

[Django]

#36654: Incorrect docstring in model _do_update
-------------------------------------+-------------------------------------
Reporter: Václav Řehák | Owner: Augusto
Type: | Pontes
Cleanup/optimization | Status: closed
Component: Database layer | Version: 6.0
(models, ORM) |
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Jacob Walls):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/36654#comment:6>