Closed Bug 636489 Opened 14 years ago Closed 14 years ago

docs could be clearer about using low level modules

Categories

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

x86
macOS
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: dietrich, Assigned: wbamberg)

Details

Attachments

(1 file)

Report from IRC. We should be clear about 1) whether you even *can* use them, and show examples, and 2) what the cost of doing so is. Transcript: 09:35 < msucan> are jetpack addons allowed to use "low level" modules? like events, collection, cortex, etc 09:37 < dietrich> msucan: yes. in the future there will likely be some kind of exposure of that information to the user. "This add-on reaches a bit further into the guts of Firefox. just FYI." 09:39 < msucan> dietrich: oky, thanks 09:39 < msucan> the docs for the internal stuff don't make it clear 09:41 < dietrich> msucan: if you have a place where it'd make sense to be in the docs, or an idea of what would make it clearer, let me know. or file a bug! 09:42 < msucan> dietrich: here http://127.0.0.1:8888/dev-guide/module-development/about.html would be sufficient to add a big fat warning that would read like 09:43 < msucan> "You can use these low level modules in your addons as well, but please note that the API is unstable and that their are mainly intended for use by the higher level modules."
Assignee: nobody → wbamberg
Rather than just say 'you can use them, but they might change' I tried to distinguish (what I see as) the different sorts of modules in the low level packages, and explain a bit about when you might want to use them.
Attachment #518557 - Flags: review?(dietrich)
Comment on attachment 518557 [details] [diff] [review] Attempt to clarify usage of low-level modules This looks great, thanks Will! Can you file a followup bug about moving those fundamental modules into add-on kit?
Attachment #518557 - Flags: review?(dietrich) → review+
Status: NEW → RESOLVED
Closed: 14 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: