Opened 18 months ago

Closed 16 months ago

Last modified 16 months ago

#34064 closed Cleanup/optimization (fixed)

USE_THOUSAND_SEPARATOR docs clarification of override by locale

Reported by: Tibor Leupold Owned by: Tibor Leupold
Component: Documentation Version: 4.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

I think there is currently some ambiguity in the last sentence of the docs for USE_THOUSAND_SEPARATOR. It is not clear (at least to me) wether the phrase "[t]hese settings" refers to NUMBER_GROUPING and THOUSAND_SEPARATOR only, or to NUMBER_GROUPING, THOUSAND_SEPARATOR and USE_THOUSAND_SEPARATOR.

USE_THOUSAND_SEPARATOR¶

Default: False

A boolean that specifies whether to display numbers using a thousand separator. When set to True and USE_L10N is also True, Django will format numbers using the NUMBER_GROUPING and THOUSAND_SEPARATOR settings. These settings may also be dictated by the locale, which takes precedence.

Change History (7)

comment:1 by Mariusz Felisiak, 18 months ago

Component: UncategorizedDocumentation
Resolution: wontfix
Status: newclosed
Type: UncategorizedCleanup/optimization

"these settings" refers to NUMBER_GROUPING and THOUSAND_SEPARATOR. TBH, I'm not sure how we could clarify this sentence further. It has already been rewritten/improved multiple times (the most recently in 80f92177eb2a175579f4a6907ef5a358863bddca). Closing as "wontix", but we may reconsider this decision after submitting a concrete proposal for changes.

Tickets are not required for small cleanups, by the way.

comment:2 by Tibor Leupold, 18 months ago

Sorry. I did not know that PRs without tickets are fine for small changes.

I have created this small PR, which I think removes the ambiguity without much other changes being necessary: https://github.com/django/django/pull/16141

comment:3 by Carlton Gibson, 16 months ago

Resolution: wontfix
Status: closednew
Triage Stage: UnreviewedReady for checkin

comment:4 by Carlton Gibson, 16 months ago

Owner: changed from nobody to Tibor Leupold
Status: newassigned

comment:5 by Carlton Gibson, 16 months ago

Has patch: set

comment:6 by Carlton Gibson <carlton.gibson@…>, 16 months ago

Resolution: fixed
Status: assignedclosed

In 33f4de34:

Fixed #34064 -- Adjusted locale override wording in settings docs.

comment:7 by Carlton Gibson <carlton.gibson@…>, 16 months ago

In 754c0c5:

[4.1.x] Fixed #34064 -- Adjusted locale override wording in settings docs.

Backport of 33f4de34e63c00616ed1624acdf9cd8adfaf33a6 from main

Note: See TracTickets for help on using tickets.
Back to Top