[Django] #23984: Document all available js_catalog's functions

9 views
Skip to first unread message

Django

unread,
Dec 12, 2014, 7:23:09 AM12/12/14
to django-...@googlegroups.com
#23984: Document all available js_catalog's functions
------------------------------------------------+------------------------
Reporter: bmispelon | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
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 |
------------------------------------------------+------------------------
The documentation at
https://docs.djangoproject.com/en/dev/topics/i18n/translation/#using-the-
javascript-translation-catalog only mentions the existence of `gettext`,
`ngettext` and `interpolate`.

There are however a few more functions that are available [1] and we
should document them.

[1]
https://github.com/django/django/blob/43041ee48c802418ec935a2ece59f876f5888c40/django/views/i18n.py#L164-L171

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

Django

unread,
Dec 12, 2014, 3:40:15 PM12/12/14
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------

Reporter: bmispelon | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
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 timgraham):

* stage: Unreviewed => Accepted


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

Django

unread,
Dec 24, 2014, 11:50:20 AM12/24/14
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------
Reporter: bmispelon | Owner: auvipy
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

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 auvipy):

* owner: nobody => auvipy
* status: new => assigned


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

Django

unread,
Mar 12, 2015, 12:41:09 PM3/12/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------
Reporter: bmispelon | Owner:
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
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 timgraham):

* owner: auvipy =>
* status: assigned => new


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

Django

unread,
Mar 22, 2015, 3:26:21 AM3/22/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
-------------------------------------+-------------------------------------
Reporter: bmispelon | Owner:
Type: | mattseymour
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

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 mattseymour):

* status: new => assigned

* owner: => mattseymour


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

Django

unread,
Mar 22, 2015, 8:32:32 AM3/22/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------
Reporter: bmispelon | Owner:

Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
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 mattseymour):

* owner: mattseymour =>


* status: assigned => new


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

Django

unread,
Mar 30, 2015, 12:58:44 PM3/30/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------
Reporter: bmispelon | Owner: dtran320
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

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 dtran320):

* status: new => assigned

* owner: => dtran320


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

Django

unread,
Apr 14, 2015, 12:29:48 PM4/14/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------
Reporter: bmispelon | Owner: dtran320
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

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
--------------------------------------+------------------------------------

Comment (by daniellindsley):

I put together a basic description of each function (as well as some
examples). I've pushed what I've got to
https://github.com/django/django/pull/4509 for
review/corrections/expansions.

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

Django

unread,
Apr 14, 2015, 12:31:47 PM4/14/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------
Reporter: bmispelon | Owner:
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
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 dtran320):

* owner: dtran320 =>


* status: assigned => new


--
Ticket URL: <https://code.djangoproject.com/ticket/23984#comment:8>

Django

unread,
Apr 14, 2015, 1:17:12 PM4/14/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
--------------------------------------+------------------------------------
Reporter: bmispelon | Owner:
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by timgraham):

* needs_better_patch: 0 => 1
* has_patch: 0 => 1


Comment:

Left some cosmetic comments.

--
Ticket URL: <https://code.djangoproject.com/ticket/23984#comment:9>

Django

unread,
Apr 16, 2015, 8:15:53 AM4/16/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
-------------------------------------+-------------------------------------
Reporter: bmispelon | Owner: Tim
Type: | Graham <timograham@…>
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Tim Graham <timograham@…>):

* owner: => Tim Graham <timograham@…>
* status: new => closed
* resolution: => fixed


Comment:

In [changeset:"8ca9bc5ec326c0b01634dac264a9ba6f0857483e" 8ca9bc5]:
{{{
#!CommitTicketReference repository=""
revision="8ca9bc5ec326c0b01634dac264a9ba6f0857483e"
Fixed #23984 -- Added Javascript i18n documentation

This fleshes out the documentation around all of the exported
Javascript functions available from the ``javascript_catalog``
view.
}}}

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

Django

unread,
Apr 16, 2015, 8:20:01 AM4/16/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
-------------------------------------+-------------------------------------
Reporter: bmispelon | Owner: Tim
Type: | Graham <timograham@…>
Cleanup/optimization | Status: closed
Component: Documentation | Version: master

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

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

Comment (by Tim Graham <timograham@…>):

In [changeset:"bcb536004a0c6a60c8c45c28c0a3127ba2321278" bcb53600]:
{{{
#!CommitTicketReference repository=""
revision="bcb536004a0c6a60c8c45c28c0a3127ba2321278"
[1.7.x] Fixed #23984 -- Added Javascript i18n documentation

This fleshes out the documentation around all of the exported
Javascript functions available from the ``javascript_catalog``
view.

Backport of 8ca9bc5ec326c0b01634dac264a9ba6f0857483e from master
}}}

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

Django

unread,
Apr 16, 2015, 8:20:01 AM4/16/15
to django-...@googlegroups.com
#23984: Document all available javascript_catalog's functions
-------------------------------------+-------------------------------------
Reporter: bmispelon | Owner: Tim
Type: | Graham <timograham@…>
Cleanup/optimization | Status: closed
Component: Documentation | Version: master

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

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

Comment (by Tim Graham <timograham@…>):

In [changeset:"1e594b257e74f60292ca421f9df11d5fd7804ea6" 1e594b25]:
{{{
#!CommitTicketReference repository=""
revision="1e594b257e74f60292ca421f9df11d5fd7804ea6"
[1.8.x] Fixed #23984 -- Added Javascript i18n documentation

This fleshes out the documentation around all of the exported
Javascript functions available from the ``javascript_catalog``
view.

Backport of 8ca9bc5ec326c0b01634dac264a9ba6f0857483e from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23984#comment:12>

Reply all
Reply to author
Forward
0 new messages