mozilla

Revision 98030 of Notes on doc-needed bugs

  • Revision slug: Project:Notes_on_doc-needed_bugs
  • Revision title: Notes on doc-needed bugs
  • Revision id: 98030
  • Created:
  • Creator: jswisher
  • Is current revision? No
  • Comment page created, 752 words added

Revision Content

The following list is based on dev-doc-needed+RESOLVED Bugzilla query. However, this list is manually maintained, and therefore may not be completely current. You can help by adding bugs that appear in the query but not in this list, with as much information as you can. If you have questions about the documentation effort for any particular bug, you can add a comment to the bug, or ask in #devmo on irc.mozilla.org or the dev-mdc@lists.mozilla.org mailing list.

 

Bug ID Title Doc Priority Doc Scope Doc Owner Notes
{{ Bug("59314") }} Alerts should be content-modal, not window-modal     Sheppy
Actively working, should be done soon (as of 2010-12-09)
{{ Bug("264308") }} Implement DOM Level 3 UserData API Low     Old bug, needs someone to figure out how it works. The spec is not very helpful. Needs to be scoped. Might need its own doc bug.
{{ Bug("321169") }} XUL templates need better logging capability      
Basically should amount to "how do you turn on and off logging of XUL templates". Add a link to https://developer.mozilla.org/en/XUL/Template_Guide for a "Debugging XUL templates" page.
{{ Bug("323810") }} [FIXr]Move forcing into tabs and current windows out of Gecko Low
Large
  For docs, see comment 13 and comment 14. The patch is very large and will take a while to go through to make sure nothing's missed. Mostly of interest to embedders, who tend to read the source anyway.
{{ Bug("368835") }} No focus events from xul tree table when a row is deleted       Need better docs of tree-related events.
{{ Bug("391829") }} Add support for container-live-role to object attributes   Easy  
Add container-live-role to 
{{ Bug("398776") }} (doorhanger) want mechanism for site-specific notification High     New API for creating doorhanger notifications. Needs sample code (based on tests?) and screenshots.
{{ Bug("407963") }} [FUEL] Factor out generic toolkit aspects of FUEL into a reusable form Medium     FUEL is an abstraction layer between extensions and interfaces. Doc work may be done, or may be incomplete. Need to compare the state of the docs and the state of the code.
{{ Bug("412819") }} Mechanism for changing an extension GUID via updates High Small   Used by Add-on developers.  Basically changes the new Addon Manager API to let an extension being installed automatically uninstall an old one, so that an add-on that's changing its GUID can get rid of the old version automatically.
{{ Bug("427293") }} "Secure Connection Failed" makes it difficult to work in the web hosting industry Low Small   At most, this is documenting a preference that most users won't touch. Start a list of "super secret use-at-your-own-risk" preferences?
{{ Bug("431503") }} Create infrastructure to test processing of key events with different keyboard layouts Low Easy   Basically adds a single method to nsIDOMWindowUtils to let you programmatically inject keyboard events for testing. Only accessible from privileged code.
{{ Bug("433616") }} [FIX]Need facility for managing documents referenced via local URI references Medium Large   Needs research (probably more research than writing). Need to identify everything that gains cross-server support because of this change and update the relevant docs.
{{ Bug("435041") }} implement Cocoa NPAPI event model for Mac OS X High+Urgent Large   Massive update to the plugin developer docs for Mac OS X. To support 64-bit plugins, plugin developers need to switch to this new event model.
{{ Bug("451729") }} Allow runtime's security callbacks to be overridden by a context Medium     JS runtime docs changes. May have been started by jorendorff; unclear if it's finished.
{{ Bug("460882") }} setTimeout loses XPCNativeWrappers   Small   Need to find all the places to mention it. Need to check whether the API change is already documented.
{{ Bug("472529") }} (websocket) Support for Web sockets' HTML5 Draft Recommendation High Large   On hold pending spec changes. Document that it's disabled by default, and how to turn it on (at own risk). Point to the spec until further notice.
{{ Bug("480735") }} Startup timeline Low Easy   Only seriously deep core devs and testers will use it. Adds new API for logging during app startup.
{{ Bug("494345") }} Do not create accessibles for XUL label or description having a role of 'presentation'   Easy  
Small API change. Should only take minutes.
{{ Bug("501423") }} StorageEvent implementation does not match the spec High+Urgent     Need to be done for Fx4. Update StorageEvent docs to match implementation (and spec).

Revision Source

<p>The following list is based on <a class=" link-https" href="https://bugzilla.mozilla.org/buglist.cgi?keywords=dev-doc-needed&amp;query_format=advanced&amp;keywords_type=allwords&amp;columnlist=assigned_to%2Cstatus_whiteboard%2Ckeywords%2Cshort_desc&amp;resolution=FIXED&amp;resolution=WORKSFORME&amp;product=Core&amp;product=Fennec&amp;product=Firefox&amp;product=NSPR&amp;product=NSS&amp;product=Tamarin&amp;product=Toolkit&amp;known_name=Updates%20Needed%20-%20Firefox%2FReady%20all%20Releases&amp;query_based_on=Updates%20Needed%20-%20Firefox%2FReady%20all%20Releases" title="https://bugzilla.mozilla.org/buglist.cgi?keywords=dev-doc-needed&amp;query_format=advanced&amp;keywords_type=allwords&amp;columnlist=assigned_to,status_whiteboard,keywords,short_desc&amp;resolution=FIXED&amp;resolution=WORKSFORME&amp;product=Core&amp;product=Fennec&amp;product=Firefox&amp;product=NSPR&amp;product=NSS&amp;product=Tamarin&amp;product=Toolkit&amp;known_name=Updates Needed - Firefox/Ready all Releases&amp;query_based_on=Updates Needed - Firefox/Ready all Releases">dev-doc-needed+RESOLVED</a> Bugzilla query. However, this list is manually maintained, and therefore may not be completely current. You can help by adding bugs that appear in the query but not in this list, with as much information as you can. If you have questions about the documentation effort for any particular bug, you can add a comment to the bug, or ask in #devmo on irc.mozilla.org or the <a class=" link-mailto" href="mailto:dev-mdc@lists.mozilla.org" rel="freelink">dev-mdc@lists.mozilla.org</a> mailing list.</p>
<p> </p>
<table border="0" cellpadding="1" cellspacing="1" class="standard-table"> <thead> <tr> <th scope="col">Bug ID</th> <th scope="col">Title</th> <th scope="col">Doc Priority</th> <th scope="col">Doc Scope</th> <th scope="col">Doc Owner</th> <th scope="col">Notes</th> </tr> </thead> <tbody> <tr> <td>{{ Bug("59314") }} </td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">Alerts should be content-modal, not window-modal</span></span></td> <td> </td> <td> </td> <td>Sheppy</td> <td><br> Actively working, should be done soon (as of 2010-12-09)</td> </tr> <tr> <td>{{ Bug("264308") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">Implement DOM Level 3 UserData API</span></span></td> <td>Low</td> <td> </td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Old bug, needs someone to figure out how it works. The spec is not very helpful. Needs to be scoped. Might need its own doc bug.</span></td> </tr> <tr> <td>{{ Bug("321169") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">XUL templates need better logging capability</span></span></td> <td> </td> <td> </td> <td> </td> <td> <div class="ace-line" id="magicdomid187"><span class="author-g-qullz122zz122zn7l52wukz122z4">Basically should amount to "how do you turn on and off logging of XUL templates". Add a link to </span><span class="author-g-qullz122zz122zn7l52wukz122z4 url"><a href="../../../../en/XUL/Template_Guide">https://developer.mozilla.org/en/XUL/Template_Guide</a></span><span class="author-g-qullz122zz122zn7l52wukz122z4"> for a "Debugging XUL templates" page.</span></div> </td> </tr> <tr> <td>{{ Bug("323810") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">[FIXr]Move forcing into tabs and current windows out of Gecko</span></span></td> <td>Low</td> <td><br> Large</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">For docs, see comment 13 and comment 14. </span><span class="author-g-qullz122zz122zn7l52wukz122z4">The patch is very large and will take a while to go through to make sure nothing's missed. Mostly of interest to embedders, who tend to read the source anyway.</span></td> </tr> <tr> <td>{{ Bug("368835") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">No focus events from xul tree table when a row is deleted</span></span></td> <td> </td> <td> </td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Need better docs of tree-related events.</span></td> </tr> <tr> <td>{{ Bug("391829") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">Add support for container-live-role to object attributes</span></span></td> <td> </td> <td>Easy</td> <td> </td> <td> <div class="ace-line" id="magicdomid420"><span class="author-g-qullz122zz122zn7l52wukz122z4">Add container-live-role to </span></div> <div class="ace-line" id="magicdomid581"><span class="author-g-ilfr7f1uo9dehk8e url"><a href="../../../../index.php?title=en/AJAX/WAI_ARIA_Live_Regions%2F%2FAPI_Support">https://developer.mozilla.org/index.php?title=en/AJAX/WAI_ARIA_Live_Regions%2F%2FAPI_Support</a></span><span class="author-g-ilfr7f1uo9dehk8e"> (is Ajax the correct topic here?)</span></div> </td> </tr> <tr> <td>{{ Bug("398776") }}</td> <td><span id="summary_alias_container">(<span id="alias_nonedit_display">doorhanger</span>) <span id="short_desc_nonedit_display">want mechanism for site-specific notification</span></span></td> <td>High</td> <td> </td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">New API for creating doorhanger notifications. Needs sample code (based on tests?) and screenshots.</span></td> </tr> <tr> <td>{{ Bug("407963") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">[FUEL] Factor out generic toolkit aspects of FUEL into a reusable form</span></span></td> <td>Medium</td> <td> </td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">FUEL is an abstraction layer between extensions and interfaces. Doc work may be done, or may be incomplete. Need to compare the state of the docs and the state of the code.</span></td> </tr> <tr> <td>{{ Bug("412819") }}</td> <td><span id="summary_alias_container"> <span id="short_desc_nonedit_display">Mechanism for changing an extension GUID via updates</span></span></td> <td>High</td> <td>Small</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Used by Add-on developers.  Basically changes the new Addon Manager API to let an extension being installed automatically uninstall an old one, so that an add-on that's changing its GUID can get rid of the old version automatically.<br> </span></td> </tr> <tr> <td>{{ Bug("427293") }}</td> <td><span id="summary_alias_container"> <span id="short_desc_nonedit_display">"Secure Connection Failed" makes it difficult to work in the web hosting industry</span></span></td> <td>Low</td> <td>Small</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">At most, this is documenting a preference that most users won't touch. Start a list of "super secret use-at-your-own-risk" preferences?</span></td> </tr> <tr> <td>{{ Bug("431503") }}</td> <td><span id="summary_alias_container"> <span id="short_desc_nonedit_display">Create infrastructure to test processing of key events with different keyboard layouts</span></span></td> <td>Low</td> <td>Easy</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Basically adds a single method to nsIDOMWindowUtils to let you programmatically inject keyboard events for testing. Only accessible from privileged code.<br> </span></td> </tr> <tr> <td>{{ Bug("433616") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">[FIX]Need facility for managing documents referenced via local URI references</span></span></td> <td>Medium</td> <td>Large</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Needs research (probably more research than writing). Need to identify everything that gains cross-server support because of this change and update the relevant docs.</span></td> </tr> <tr> <td>{{ Bug("435041") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">implement Cocoa NPAPI event model for Mac OS X</span></span></td> <td>High+Urgent</td> <td>Large</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Massive update to the plugin developer docs for Mac OS X. To support 64-bit plugins, plugin developers need to switch to this new event model.</span></td> </tr> <tr> <td>{{ Bug("451729") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">Allow runtime's security callbacks to be overridden by a context</span></span></td> <td>Medium</td> <td> </td> <td> </td> <td>JS runtime docs changes. May have been started by jorendorff; unclear if it's finished.</td> </tr> <tr> <td>{{ Bug("460882") }}</td> <td><span id="summary_alias_container"> <span id="short_desc_nonedit_display">setTimeout loses XPCNativeWrappers</span></span></td> <td> </td> <td>Small</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Need to find all the places to mention it. Need to check whether the API change is already documented.</span></td> </tr> <tr> <td>{{ Bug("472529") }}</td> <td><span id="summary_alias_container">(<span id="alias_nonedit_display">websocket</span>) <span id="short_desc_nonedit_display">Support for Web sockets' HTML5 Draft Recommendation</span></span></td> <td>High</td> <td>Large</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">On hold pending spec changes. Document that it's disabled by default, and how to turn it on (at own risk). Point to the spec until further notice.</span></td> </tr> <tr> <td>{{ Bug("480735") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">Startup timeline</span></span></td> <td>Low</td> <td>Easy</td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Only seriously deep core devs and testers will use it. Adds new API for logging during app startup.</span></td> </tr> <tr> <td>{{ Bug("494345") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">Do not create accessibles for XUL label or description having a role of 'presentation'</span></span></td> <td> </td> <td>Easy</td> <td> </td> <td> <div class="ace-line" id="magicdomid1342"><span class="author-g-qullz122zz122zn7l52wukz122z4">Small API change. Should only take minutes.</span></div> </td> </tr> <tr> <td>{{ Bug("501423") }}</td> <td><span id="summary_alias_container"><span id="short_desc_nonedit_display">StorageEvent implementation does not match the spec</span></span></td> <td>High+Urgent</td> <td> </td> <td> </td> <td><span class="author-g-qullz122zz122zn7l52wukz122z4">Need to be done for Fx4. Update StorageEvent docs to match implementation (and spec).</span></td> </tr> </tbody>
</table>
Revert to this revision