mozilla

Compare Revisions

How to resolve a dev-doc-needed bug

Change Revisions

Revision 316307:

Revision 316307 by jenzed on

Revision 316311:

Revision 316311 by jenzed on

Title:
How to resolve a dev-doc-needed bug
How to resolve a dev-doc-needed bug
Slug:
User:jenzed/How_to_resolve_a_dev-doc-needed_bug
User:jenzed/How_to_resolve_a_dev-doc-needed_bug
Content:

Revision 316307
Revision 316311
n8      This page describes how to update MDN to match the changes n8      Bugzilla is a web-based application that is used to track a
>that were tracked in <a href="https://bugzilla.mozilla.org/show_b>ll changes to all Mozilla software projects. Some bugs (flagged w
>ug.cgi?id=761495" title="https://bugzilla.mozilla.org/show_bug.cg>ith the "dev-doc-needed" keyword) require changes to the document
>i?id=761495">Bugzilla bug # 761495</a>. Sometimes the comments an>ation on MDN as well as changes to the source code. However, some
>d descriptions in bugs are obscure and mysterious. This page atte>times the comments and descriptions in bugs are obscure and it is
>mpts to provide clues and hints on how to decode a bug and find o> difficult to understand what needs to be done on MDN. This page 
>ut what needs to be changed on MDN.>provides a description and example of the steps we use to update 
 >MDN.
n10    <h2>n10    <h2 id="A_JavaScript_Update">
n14      MDN Documentation bug trackern14      MDN Doc bug tracker
n17      The first step in addressing a bug with the "dev-doc-neededn17      The first step in addressing a bug with the "dev-doc-needed
>" keyword is to find a bug with the "dev-doc-needed" keyword. The>" keyword is to find a bug with the "dev-doc-needed" keyword. The
> <a href="http://beta.elchi3.de/doctracker/#list=fx&amp;version="> <a href="http://beta.elchi3.de/doctracker/#list=fx&amp;version="
> title="http://beta.elchi3.de/doctracker/#list=fx&amp;version=">M> title="http://beta.elchi3.de/doctracker/#list=fx&amp;version=">M
>DN Doc bug tracker</a> is a front-end to Bugzilla that makes it m>DN Doc bug tracker</a> is a front-end to Bugzilla that makes it e
>uch easier to find bugs that require updates on MDN. Your search >asy to find bugs that require updates on MDN.
>might have returned <a href="https://bugzilla.mozilla.org/show_bu 
>g.cgi?id=761495" title="https://bugzilla.mozilla.org/show_bug.cgi 
>?id=761495">bug # 761495</a>. 
n23      In Bugzilla, we see that <a href="https://bugzilla.mozilla.n23      Your search on the MDN Doc bug tracker might have returned 
>org/show_bug.cgi?id=761495" title="https://bugzilla.mozilla.org/s><a href="https://bugzilla.mozilla.org/show_bug.cgi?id=761495" tit
>how_bug.cgi?id=761495">bug # 761495</a> has the title: "<span id=>le="https://bugzilla.mozilla.org/show_bug.cgi?id=761495">bug # 76
>"summary_alias_container">(<span id="alias_nonedit_display">harmo>1495</a>. In Bugzilla, we see that <a href="https://bugzilla.mozi
>ny:inthelpers</span>) <span id="short_desc_nonedit_display">add N>lla.org/show_bug.cgi?id=761495" title="https://bugzilla.mozilla.o
>umber.isInteger/toInteger."</span></span> This suggest a couple o>rg/show_bug.cgi?id=761495">bug # 761495</a> has the title: "<span
>f things:> id="summary_alias_container">(<span id="alias_nonedit_display">h
 >armony:inthelpers</span>) <span id="short_desc_nonedit_display">a
 >dd Number.isInteger/toInteger."</span></span> This suggests a cou
 >ple of things:
n29      <li>"<span id="summary_alias_container"><span id="short_desn29      <li>"<span id="summary_alias_container"><span id="short_des
>c_nonedit_display">Number.isInteger/toInteger": This looks like s>c_nonedit_display">Number.isInteger/toInteger": This looks like s
>horthand for two method name</span></span>s.>horthand for two object / method name</span></span>s.
n38    <h3>n38    <h3 id="Source_code">
n42      Following the link shows the changes that were made in the n42      Following the link shows the changes that were made in the 
>source code. The description of the change ("add Number.isInteger>source code. The description of the change ("add Number.isInteger
> and Number.toInteger") confirms that this is indeed a change to > and Number.toInteger") confirms that this is indeed a change to 
>the <code>Number</code> object, adding the <code>isInteger</code>>the <code>Number</code> object. It adds the <code>isInteger</code
> and <code>toInteger</code> methods.>> and <code>toInteger</code> methods.
n45      The third link in the list of changed files points to the rn45      The third link in the list of changed files points to the r
>elevant change in the source code (<code>jsnum.cpp</code>). (The >elevant change in the source code (<code>jsnum.cpp</code>). (The 
>other two files contain test cases.)>other two links point to files that contain test cases.)
n48      Scrolling down, we see the actual change itself. A comment n48      Scrolling down, we see the actual change itself. A comment 
>tells us which version of the ECMAScript standard implemented the>tells us which version of the ECMAScript standard implemented the
> change ("// ES6 draft ES6 15.7.3.12"). If we search the internet> change ("// ES6 draft ES6 15.7.3.12"). If we search the internet
> for "ecmascript harmony number isinteger" we find the descriptio> for "ecmascript harmony number isinteger" we find the descriptio
>ns of the <code>isInteger</code> and <code>toInteger</code> metho>ns of the <code>isInteger</code> and <code>toInteger</code> metho
>ds in the <a href="http://wiki.ecmascript.org/doku.php?id=harmony>ds in the <a href="http://wiki.ecmascript.org/doku.php?id=harmony
>:number.tointeger&amp;s=tointeger" title="http://wiki.ecmascript.>:number.tointeger&amp;s=tointeger" title="http://wiki.ecmascript.
>org/doku.php?id=harmony:number.tointeger&amp;s=tointeger">ECMAScr>org/doku.php?id=harmony:number.tointeger&amp;s=tointeger">ECMAScr
>ipt Harmony specification</a>. This is the reference on which we >ipt Harmony specification</a>. This is the reference on which we 
>can base our changes in MDN>can base our changes in MDN.
n50    <h3>n50    <h3 id="MDN">
n54      In MDN, we search for the JavaScript <a href="https://develn54      In MDN, we search for the JavaScript <a href="https://devel
>oper.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/N>oper.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/N
>umber" title="https://developer.mozilla.org/en-US/docs/JavaScript>umber" title="https://developer.mozilla.org/en-US/docs/JavaScript
>/Reference/Global_Objects/Number"><code>Number</code> object</a>.>/Reference/Global_Objects/Number"><code>Number</code> object</a>.
> In the Methods section of that page, we add the <code>isInteger<> In the Methods section of that page, we add the <code>isInteger<
>/code> and <code>toInteger</code> methods. We note that the metho>/code> and <code>toInteger</code> methods. We note that the metho
>ds were added in version 16 of Firefox by using the "<code>fx_min>ds were added in version 16 of Firefox by using the "<code>fx_min
>version_inline("16")</code> template. <span style="background-col>version_inline("16")</code> template. <span style="background-col
>or:#ffff00;">(Why does the isNaN method have a page bug not the o>or:#ffff00;">(Why does the isNaN method have a page but not the o
>thers?)</span>>thers?)</span>
n59    <h3>n59    <h3 id="Update_Bugzilla">
t72      <li>&nbsp;t
73      </li>

Back to History