711956 - Improve docs for the preference-service reset method

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, enhancement, P3)

Description

[noitidart]

User Agent: Mozilla/5.0 (Windows NT 5.1; rv:8.0) Gecko/20100101 Firefox/8.0
Build ID: 20111104165243

Steps to reproduce:

read doc on pref reset here:
https://addons.mozilla.org/en-US/developers/docs/sdk/1.3/packages/api-utils/docs/preferences-service.html#set(name%2C value)


Actual results:

didn't get full info, it just said: "Clears a non-default, user-set value from the application preference name. If no user-set value is defined on name, the function does nothing."


Expected results:

it should have said:
"Clears a non-default, user-set value from the application preference name. If no user-set value is defined on name, the function does nothing. If no default value exists the preference will cease to exist."

Please notice the last sentence. It is from here:
https://developer.mozilla.org/en/nsIPrefBranch#clearUserPref%28%29

Special thanks to ZER0 for this help!

Comment 1

[Daniel Buchner [:dbuc]]

This is an SDK issue, refiling to appropriate component.

Comment 2

[Erik Vold]

Attachment: Pointer to Github pull request: https://github.com/mozilla/addon-sdk/pull/386

Pointer to Github pull-request

Comment 3

[[github robot]]

Commit pushed to master at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/fa2f497d4f9809e72b2e8de96e0ecb7f3e5b9f06
Merge pull request #386 from erikvold/bug-711956

Bug 711956 Improve docs for the preference-service reset method