745854 - Need to document the simple-prefs types that are available.

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P1)

Description

[Erik Vold]

It's not clear which simple-prefs types are available to users, so they should be listed in the documentation.

Comment 1

[Erik Vold]

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

Pointer to Github pull-request

Comment 2

[Will Bamberg [:wbamberg]]

Comment on attachment 615807 [details]
Pointer to Github pull request: https://github.com/mozilla/addon-sdk/pull/405

As it stands this is fine, although I think the headings should be capitalized: "Type", "Displayed As", "Stored As".

But it's quite terse, and not terribly helpful without https://developer.mozilla.org/en/Extensions/Inline_Options (which isn't itself linked from this page). Maybe there could be 2 extra columns:
- description: explaining briefly what each of these settings mean and what they're for
- an example JSON specification for each setting

Comment 3

[Will Bamberg [:wbamberg]]

Attachment: expanded simple-prefs docs

I've expanded the stuff on types to include examples, and added a section on the different attributes of a setting specification. Please take a look, and if you're happy I'll land it.

Comment 4

[Erik Vold]

(In reply to Will Bamberg [:wbamberg] from comment #3)
> Created attachment 624930 [details] [diff] [review]
> expanded simple-prefs docs
> 
> I've expanded the stuff on types to include examples, and added a section on
> the different attributes of a setting specification. Please take a look, and
> if you're happy I'll land it.

Very happy!  I pulled your changes in to my branch, but I excluded some changes that seemed unrelated to this bug.  So you should see your commits in https://github.com/mozilla/addon-sdk/pull/405

Comment 5

[[github robot]]

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

https://github.com/mozilla/addon-sdk/commit/65bb376c8a9ef8e24d50790f8ab1a373e6cd8dea
Bug 745854 mentioning the simple-prefs types that have been implemented

https://github.com/mozilla/addon-sdk/commit/0bec6bb046d5946053c8c05cd321ebd906e0fc1e
Merge pull request #405 from erikvold/bug-745854

Bug 745854 mentioning the simple-prefs types that have been implemented

Comment 6

[[github robot]]

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

https://github.com/mozilla/addon-sdk/commit/4191dc0691c700aaea34dbeb15b9f306d245858b
Merge pull request #405 from erikvold/bug-745854

Bug 745854 mentioning the simple-prefs types that have been implemented(cherry picked from commit 0bec6bb046d5946053c8c05cd321ebd906e0fc1e)