1834595 - Improve readability, clarity, and documentation of defineLazyPreferenceGetter

Status: RESOLVED FIXED

(Core :: XPConnect, task)

Description

[Erik Nordin [:nordzilla]]

I recently ran into an issue where I was confused about the parameter aDefaultValue in defineLazyPreferenceGetter.

I assumed this should be the default value of the overall return type from the getter, i.e. after applying aTransform.

However, this parameter should be the default value of the raw preference, before applying aTransform.

The documentation and variable names aren't really clear to me, so this patch will improve that for future users of this functionality.

Comment 1

[Erik Nordin [:nordzilla]]

Attachment: Bug 1834595 - Improve clarity of defineLazyPreferenceGetter r=standard8

Improves the clarity of defineLazyPreferenceGetter by resolving
ambiguity around the intended type of parameter aDefaultValue

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a1a0bde11b7e
Improve clarity of defineLazyPreferenceGetter r=kmag

Comment 3

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/a1a0bde11b7e