691022 - pagemod docs say "ready" and "end" are ok values for contentScriptWhen, which is confusing

Status: RESOLVED FIXED

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

Description

[Dietrich Ayala (:dietrich)]

in the page-mod documentation at:

https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/packages/addon-kit/docs/page-mod.html

it says:

"If you specify a value of "ready" or "end" for contentScriptWhen, then the content script can interact with the DOM itself:"

i'm talking to an add-on dev at a conference who thought 'start' was not available for page-mod, since it's not listed here.

minor change, but caused serious confusion :)

Comment 1

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

It actually does mention 'start' at the bottom of the page ( https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/packages/addon-kit/docs/page-mod.html#PageMod%28options%29 ) in the Constructors section, but yeah, probably wouldn't hurt to mention it up at the top as well.

Comment 2

[[github robot]]

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

https://github.com/mozilla/addon-sdk/commit/b9e53cc412db82c2a674584260d8cc80b3302f94
Merge pull request #273 from erikvold/bug-691022

Bug 691022: mention 'start' option for contentScriptWhen some more

Comment 3

[Will Bamberg [:wbamberg]]

Thanks Erik!