'file' module Markdown docs need to document all public functions

RESOLVED FIXED

Status

Add-on SDK
General
RESOLVED FIXED
8 years ago
7 years ago

People

(Reporter: atul, Assigned: adw)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Reporter)

Description

8 years ago
Currently, the Mardown docs for the 'file' module [1] do not document a number of public functions, such as read() and open().  They need to.

[1] https://jetpack.mozillalabs.com/sdk/0.1/docs/#module/jetpack-core/file
(Reporter)

Updated

8 years ago
Blocks: 551040
It'd be great to get this for 0.2, but I'd ship without it, so it doesn't block the release.
No longer blocks: 551040
(Assignee)

Comment 2

8 years ago
Created attachment 434788 [details] [diff] [review]
patch

Since I added some methods, I can take this.  I alphabetized the list too.
Assignee: nobody → adw
Status: NEW → ASSIGNED
Attachment #434788 - Flags: review?(avarma)
(Reporter)

Comment 3

8 years ago
Awesome, this is great!!

Thanks Drew. Pushed: http://hg.mozilla.org/labs/jetpack-sdk/rev/3b50ef2b7b56
(Reporter)

Updated

8 years ago
Status: ASSIGNED → RESOLVED
Last Resolved: 8 years ago
Resolution: --- → FIXED
(Reporter)

Comment 4

8 years ago
Also, it looks like we'll need a way to link to other documentation files in the SDK, so that when you mention "ByteReader" and "ByteWriter" they're linked to the docs for byte-streams.js... Hmm.
(Assignee)

Updated

8 years ago
Attachment #434788 - Flags: review?(avarma)
The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".
Component: Jetpack SDK → General
Product: Mozilla Labs → Add-on SDK
QA Contact: jetpack-sdk → general
Version: Trunk → unspecified
You need to log in before you can comment on or make changes to this bug.