664001 - 'self' module has gone missing from the docs

Status: RESOLVED FIXED

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

Description

[Will Bamberg [:wbamberg]]

Probably as a result of bug 615244, the 'self' module doesn't show up in the list of modules in the doc sidebar any more. The code in webdocs.py fetches the set of modules in a package, then filters it using the set of corresponding MD files. Since self.js doe not exist under addon-kit/lib, the code does not include it in the list of modules.

Comment 1

[Brian Warner [:warner :bwarner]]

argh. I'd assumed that the doc sidebar was built from the list of *.md files. Yeah, I guess we need to special-case that one.

Comment 2

[Will Bamberg [:wbamberg]]

(In reply to comment #1)
> argh. I'd assumed that the doc sidebar was built from the list of *.md
> files. Yeah, I guess we need to special-case that one.

Yes, but I can't think of any reason why it should _not_ just be built from the list of MD files, can you?

Comment 3

[Brian Warner [:warner :bwarner]]

Attachment: hack to get 'self' back into the docs

Quick hack to get 'self' back into the docs, by forcibly adding it to the (normally calculated) list of documented modules for the addon-kit package. Probably good enough for 1.0, but not the long-term fix.

Will: yeah, I think it ought to be generated from *.md too. Fixing that right now is too risky, though, as the code is pretty intricately wrapped around the idea of looking at the scanned package's data structure of .js modules. I'll file a bug to fix that after 1.0 .

Comment 4

[Brian Warner [:warner :bwarner]]

Bug 664053 added for the long-term fix.

Comment 5

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

Comment on attachment 539077 [details] [diff] [review]
hack to get 'self' back into the docs

r=myk, and a=myk for commission during freeze, although drivers'll probably mark this a blocker.

Comment 6

[Brian Warner [:warner :bwarner]]

Landed in https://github.com/mozilla/addon-sdk/commit/262117fe2937b81a06bdec731b44ad8411d2dc94