Opened 12 years ago
Last modified 7 years ago
#18394 closed Cleanup/optimization
Better docs, and possibly better handling, for 'packages' argument to javascript_catalog — at Initial Version
Reported by: | James Bennett | Owned by: | nobody |
---|---|---|---|
Component: | Internationalization | Version: | dev |
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
The javascript_catalog
i18n view's
packages
argument only accepts modules which are either
django.conf
or which are also in
INSTALLED_APPS
. But there are two issues with this:
- The documentation for the view hides this a bit, and can create the impression that the restriction only applies to a
packages
argument passed through the URL.
- The view itself does not give you any warning if you're violating this restriction; it just silently discards anything in
packages
that doesn't meet the requirements.
At the very least, the documentation should be more up-front that this requirement always applies no matter how you're passing packages
to the view. Possibly as a bonus, the view should warn that it's discarding any packages that don't conform to the requirements, to aid in debugging.
Note:
See TracTickets
for help on using tickets.