[Django] #18596: Documentation of javascript_catalog isn't very clear

[Django]

#18596: Documentation of javascript_catalog isn't very clear
------------------------------------------------+------------------------
Reporter: aaugustin | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Accepted | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
This is the documentation part of #18394.

The [https://docs.djangoproject.com/en/dev/topics/i18n/translation
/#module-django.views.i18n documentation of javascript_catalog] should:
a) explain what the view does
b) explain what the packages arguments are and what restrictions apply
c) explain how the view can be invoked
d) exlpain the technical details (for advanced use)

Currently all this information is mixed and it can be confusing.

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

[Django]

#18596: Documentation of JavaScriptCatalog isn't very clear
--------------------------------------+------------------------------------

Reporter: aaugustin | 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: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Description changed by timgraham:

Old description:

> This is the documentation part of #18394.
>
> The [https://docs.djangoproject.com/en/dev/topics/i18n/translation
> /#module-django.views.i18n documentation of javascript_catalog] should:
> a) explain what the view does
> b) explain what the packages arguments are and what restrictions apply
> c) explain how the view can be invoked
> d) exlpain the technical details (for advanced use)
>
> Currently all this information is mixed and it can be confusing.

New description:

This is the documentation part of #18394.

The [https://docs.djangoproject.com/en/dev/topics/i18n/translation
/#module-django.views.i18n documentation of JavaScriptCatalog] should:

a) explain what the view does
b) explain what the packages arguments are and what restrictions apply
c) explain how the view can be invoked

d) explain the technical details (for advanced use)

Currently all this information is mixed and it can be confusing.

--

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

[Django]

#18596: Documentation of JavaScriptCatalog isn't very clear
--------------------------------------+------------------------------------

Reporter: Aymeric Augustin | Owner: nobody
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

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

Comment:

`JavaScriptCatalog` documentation was improved in
de40cfbe74642df1e94c131e1adaa3363173c0cf.

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