Add deprecation warning for convertPreferences() #11174
Conversation
| @@ -528,7 +532,7 @@ define(function (require, exports, module) { | |||
| * @return {boolean} true if a value was set | |||
| */ | |||
| function setValueAndSave(id, value, options) { | |||
| DeprecationWarning.deprecationWarning("setValueAndSave called for " + id + ". Use set instead."); | |||
There was a problem hiding this comment.
@le717 Wording looks OK to me. Should we make use of the second param, oncePerCaller, for deprecationWarning.
|
@nethip Suggested change made, ready to go. |
| @@ -528,7 +532,7 @@ define(function (require, exports, module) { | |||
| * @return {boolean} true if a value was set | |||
| */ | |||
| function setValueAndSave(id, value, options) { | |||
| DeprecationWarning.deprecationWarning("setValueAndSave called for " + id + ". Use set instead."); | |||
| DeprecationWarning.deprecationWarning("PreferencesManager.setValueAndSave() called for " + id + ". Use set instead.", true); | |||
There was a problem hiding this comment.
To be consistent, we should change set to PreferencesManager.set(), too.
Otherwise, this looks good and we definitely want this in Release 1.4.
|
Could you also add the |
|
@marcelgerber All changes made. |
| @@ -123,7 +125,7 @@ define(function (require, exports, module) { | |||
| // having _doNotCreate set to true, then the caller is using the old preferences model. | |||
| if (!_doNotCreate) { | |||
| var clientString = typeof clientID === "object" ? clientID.uri : clientID; | |||
| DeprecationWarning.deprecationWarning("getPreferenceStorage is called with client ID '" + clientString + ",' use PreferencesManager.definePreference instead."); | |||
| DeprecationWarning.deprecationWarning("PreferencesManager.getPreferenceStorage() is called with client ID '" + clientString + ",' use PreferencesManager.definePreference() instead."); | |||
There was a problem hiding this comment.
The closing single quote should come before comma after printing the client string.
Also more importantly, we could have a uniform deprecation message instead of three different on various occasions. I would suggest a simple and uniform:-
"PreferencesManager.<some_deprecated_fn> called with client id <client_id> has been deprecated. Use PreferencesManager.<updated_fn> instead".
There was a problem hiding this comment.
Updated message. Is that better?
|
The messages are still not quite streamlined, but as it's unlikely, for an end user, to get both at the same time, I'll merge anyway. |
Add deprecation warning for convertPreferences()
|
Edit: There are more than one instance where it is being used. |
|
@sprintr Apologies for what's probably a dumb question, but how exactly would that be updated? Resizer is a core (but not core extension) module, but I have never seen a |
For #10412.
@nethip Any suggestions for the message wording?