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

Status: RESOLVED FIXED

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

Description

[Atul Varma [:atul]]

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

Comment 1

[Myk Melez [:myk] [@mykmelez]]

It'd be great to get this for 0.2, but I'd ship without it, so it doesn't block the release.

Comment 2

[Drew Willcoxon :adw]

Attachment: patch

Since I added some methods, I can take this.  I alphabetized the list too.

Comment 3

[Atul Varma [:atul]]

Awesome, this is great!!

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

Comment 4

[Atul Varma [:atul]]

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.

Comment 5

[Myk Melez [:myk] [@mykmelez]]

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".