Re: [Django] #28939: Document which ORM methods provide an instance hint to database routers

[Django]

#28939: Document which ORM methods provide an instance hint to database routers
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: prefetch, | Triage Stage: Accepted
prefetch_related, using, |
connection |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Ülgen Sarıkavak):

* cc: Ülgen Sarıkavak (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/28939#comment:6>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#28939: Document which ORM methods provide an instance hint to database routers
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: prefetch, | Triage Stage: Accepted
prefetch_related, using, |
connection |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Ahmed Nassar):

why this ticket doesn't closed? If need anything else, let me know. I will
happy to work on.
--
Ticket URL: <https://code.djangoproject.com/ticket/28939#comment:7>

[Django]

#28939: Document which ORM methods provide an instance hint to database routers
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: prefetch, | Triage Stage: Accepted
prefetch_related, using, |
connection |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Natalia Bidart):

Replying to [comment:7 Ahmed Nassar]:

> why this ticket doesn't closed? If need anything else, let me know. I
will happy to work on.

Hello Ahmed, thanks for your interest in this ticket. If you read the PR
comments, specifically
[https://github.com/django/django/pull/10823#pullrequestreview-490408236
this one], there is a hint about what's pending:

> Let's call it Refs #28939 — there's the task of improving the
documentation around hints to the router there. (I'll rebase now.)
--
Ticket URL: <https://code.djangoproject.com/ticket/28939#comment:8>

[Django]

#28939: Document which ORM methods provide an instance hint to database routers
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: prefetch, | Triage Stage: Accepted
prefetch_related, using, |
connection |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Aliyah Stephens):

Hi, I'd like to work on this ticket to document which ORM methods provide
an instance hint to database routers.

Based on the discussion, I understand this is about improving the
documentation in the "Hints" section of the multi-database documentation
to clarify which ORM methods (like Model.save(), RelatedManager.add(),
etc.) pass instance hints to router.db_for_read() and
router.db_for_write() methods.

I'm claiming this ticket and will start working on a patch to add this
documentation.
--
Ticket URL: <https://code.djangoproject.com/ticket/28939#comment:9>

[Django]

#28939: Document which ORM methods provide an instance hint to database routers
-------------------------------------+-------------------------------------

Reporter: Nick Pope | Owner: Aliyah
Type: | Stephens
Cleanup/optimization | Status: assigned

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: prefetch, | Triage Stage: Accepted
prefetch_related, using, |
connection |

Has patch: 1 | Needs documentation: 0

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

Changes (by Aliyah Stephens):

* cc: Aliyah Stephens (added)
* has_patch: 0 => 1
* owner: nobody => Aliyah Stephens
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/28939#comment:10>

[Django]

#28939: Document which ORM methods provide an instance hint to database routers
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: Aliyah
Type: | Stephens
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: prefetch, | Triage Stage: Accepted
prefetch_related, using, |
connection |
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Jacob Walls):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/28939#comment:11>