[Django] #34463: WHERE clause example missing from Q() documentation

1 view
Skip to first unread message

Django

unread,
Apr 6, 2023, 2:06:19 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
------------------------------------------------+------------------------
Reporter: ExTexan | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 4.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
On this page:
https://docs.djangoproject.com/en/4.2/topics/db/queries/#complex-lookups-
with-q-objects

...a short way down from the section title: "Complex lookups with Q
objects"

...is a line that says: "This is equivalent to the following SQL WHERE
clause:"

but the WHERE clause is not shown.

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

Django

unread,
Apr 6, 2023, 2:25:10 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
--------------------------------------+------------------------------------

Reporter: ExTexan | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* stage: Unreviewed => Accepted


Comment:

Great catch! There is a typo in
[https://github.com/django/django/blob/main/docs/topics/db/queries.txt#L1371
the docs source], it should be `.. code-block:: sql`, so the second `:` is
missing. Would you like to prepare a patch?

Please fix also the same typo in
[https://github.com/django/django/blob/38e63c9e61152682f3ff982c85a73793ab6d3267/docs/topics/i18n/translation.txt#L267
docs/topics/i18n/translation.txt].

--
Ticket URL: <https://code.djangoproject.com/ticket/34463#comment:1>

Django

unread,
Apr 6, 2023, 5:41:20 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
-------------------------------------+-------------------------------------
Reporter: ExTexan | Owner: Yahya Ali
Type: | Status: assigned
Cleanup/optimization |

Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Yahya Ali):

* owner: nobody => Yahya Ali
* status: new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/34463#comment:2>

Django

unread,
Apr 6, 2023, 6:44:25 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
-------------------------------------+-------------------------------------
Reporter: ExTexan | Owner: Yahya Ali
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Yahya Ali):

* has_patch: 0 => 1


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

Django

unread,
Apr 6, 2023, 6:52:07 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
-------------------------------------+-------------------------------------
Reporter: ExTexan | Owner: Yahya Ali
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Yahya Ali):

PR https://github.com/django/django/pull/16733

--
Ticket URL: <https://code.djangoproject.com/ticket/34463#comment:4>

Django

unread,
Apr 6, 2023, 7:04:15 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
-------------------------------------+-------------------------------------
Reporter: ExTexan | Owner: Yahya Ali
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):

* stage: Accepted => Ready for checkin


--
Ticket URL: <https://code.djangoproject.com/ticket/34463#comment:5>

Django

unread,
Apr 6, 2023, 7:08:24 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
-------------------------------------+-------------------------------------
Reporter: ExTexan | Owner: Yahya Ali
Type: | Status: closed

Cleanup/optimization |
Component: Documentation | Version: 4.2
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: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by GitHub <noreply@…>):

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


Comment:

In [changeset:"263db8af469f0f3a5bd8ddc4a7dd0154c3d1fbca" 263db8a]:
{{{
#!CommitTicketReference repository=""
revision="263db8af469f0f3a5bd8ddc4a7dd0154c3d1fbca"
Fixed #34463 -- Corrected code-block directives in docs.

Thanks ExTexan for the report.
}}}

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

Django

unread,
Apr 6, 2023, 7:09:14 AM4/6/23
to django-...@googlegroups.com
#34463: WHERE clause example missing from Q() documentation
-------------------------------------+-------------------------------------
Reporter: ExTexan | Owner: Yahya Ali
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 4.2
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: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"e68da20596847d6c165183bca52ebba570ccfdaa" e68da20]:
{{{
#!CommitTicketReference repository=""
revision="e68da20596847d6c165183bca52ebba570ccfdaa"
[4.2.x] Fixed #34463 -- Corrected code-block directives in docs.

Thanks ExTexan for the report.

Backport of 263db8af469f0f3a5bd8ddc4a7dd0154c3d1fbca from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/34463#comment:7>

Reply all
Reply to author
Forward
0 new messages