Opened 23 months ago

Closed 23 months ago

Last modified 23 months ago

#33804 closed Cleanup/optimization (fixed)

GinIndex's gin_pending_list_limit parameter is in kilobytes.

Reported by: sidty Owned by: Ian Wootten
Component: Documentation Version: 4.0
Severity: Normal Keywords: GinIndex
Cc: sidty Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

In django postgres-GinIndex docs (​https://docs.djangoproject.com/en/4.0/ref/contrib/postgres/indexes/#ginindex)
In last paragraph of GinIndex docs.
"Provide an integer number of bytes ..."

But in postgres (​https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-GIN-PENDING-LIST-LIMIT)
In mid of 2nd line of paragraph.
"If this value is specified without units, it is taken as kilobytes. "

(And django sends value without any units.)
So django-docs asks for bytes but postgres-docs check for kilobytes.

Change History (10)

comment:1 by sidty, 23 months ago

Cc: sidty added

comment:2 by Mariusz Felisiak, 23 months ago

Easy pickings: set
Summary: Postgres GinIndex Documentation bug!!! → GinIndex's gin_pending_list_limit parameter is in kilobytes.
Triage Stage: Unreviewed → Accepted
Type: Bug → Cleanup/optimization

Thanks for the report. PostgreSQL docs starts do mention kilobytes in version 12+, so we should amend this.

comment:3 by Mariusz Felisiak, 23 months ago

Would you like to prepare a patch?

in reply to:  3 comment:4 by sidty, 23 months ago

Replying to Mariusz Felisiak:

Would you like to prepare a patch?

Actually I am struggling a lot with internet speed at my current location. I would like you to do it.

comment:5 by Ian Wootten, 23 months ago

Owner: changed from nobody to Ian Wootten
Status: new → assigned

comment:6 by Ian Wootten, 23 months ago

Has patch: set
Resolution: → fixed
Status: assigned → closed

Fixed this in this PR: ​https://github.com/django/django/pull/15794

comment:7 by Mariusz Felisiak, 23 months ago

Resolution: fixed
Status: closed → new
Triage Stage: Accepted → Ready for checkin

This is not fixed, because the patch has not yet been merged (see ​Triage workflow).

Last edited 23 months ago by Mariusz Felisiak (previous) (diff)

comment:8 by GitHub <noreply@…>, 23 months ago

Resolution: → fixed
Status: new → closed

In 6f63e0c:

Fixed #33804 -- Corrected GinIndex.gin_pending_list_limit description in docs.

comment:9 by Mariusz Felisiak <felisiak.mariusz@…>, 23 months ago

In 2026314b:

[4.1.x] Fixed #33804 -- Corrected GinIndex.gin_pending_list_limit description in docs.

Backport of 6f63e0ce8e36fbdb2d0c4dfd77ed3cf02e467f49 from main

in reply to:  9 comment:10 by sidty, 23 months ago

Replying to Mariusz Felisiak <felisiak.mariusz@…>:

In 2026314b:

[4.1.x] Fixed #33804 -- Corrected GinIndex.gin_pending_list_limit description in docs.

Backport of 6f63e0ce8e36fbdb2d0c4dfd77ed3cf02e467f49 from main

Thanks for getting it live!!!

Last edited 23 months ago by sidty (previous) (diff)
Note: See TracTickets for help on using tickets.
Back to Top