addCustomFormats documentation is incorrect

[freddefisk]

The live documentation ​http://livedocs.dojotoolkit.org/dojo/date/locale/addCustomFormats is incorrect:

require(["dojo/date/locale", "dojo/i18n!dojo/cldr/nls/gregorian"], function(locale, gregorian){
	var bundle = {
		timeFormat-custom: "HH:mm:ss.zzzz",
		dateFormat-custom: "d-MMMM-y"
	};
	locale.addCustomFormats(gregorian, bundle);
});

addCustomFormats takes package name and bundle name as arguments. This is what I came up with. It works for me, but I'm not sure it's correct:

require(["dojo/_base/kernel", "dojo/date/locale", "dojo/i18n"], function(kernel, locale, i18n){
	var bundle = {
		timeFormat-custom: "HH:mm:ss.zzzz",
		dateFormat-custom: "d-MMMM-y"
	};
	i18n.cache("mypackage/nls/gregorian/" + kernel.locale, bundle);
	locale.addCustomFormats("mypackage", "gregorian");
});

[freddefisk]

Seems like i18n.cache has changed from a function to an object in [28456]. So the new example code should be

require(["dojo/_base/kernel", "dojo/date/locale", "dojo/i18n"], function(kernel, locale, i18n){
	var bundle = {
		timeFormat-custom: "HH:mm:ss.zzzz",
		dateFormat-custom: "d-MMMM-y"
	};
	i18n.cache["mypackage/nls/gregorian/" + kernel.locale] = bundle;
	locale.addCustomFormats("mypackage", "gregorian");
});

[freddefisk]

I updated the live doc according to my latest comment. If this is the correct usage, this ticket can be closed.

[Adam Peller]

freddefisk, thank you for correcting the docs. I believe addCustomFormats has always taken two strings. The bundle could also be loaded using require and the i18n! plugin, but I think i18n.cache should be valid also.