mozilla

Compare Revisions

How to resolve a dev-doc-needed bug

Change Revisions

Revision 316305:

Revision 316305 by jenzed on

Revision 316307:

Revision 316307 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 316305
Revision 316307
nn11      A JavaScript Update
12    </h2>
13    <h3 id="MDN_Documentation_bug_tracker">
n12    </h2>n15    </h3>
n16    <h2>n19    <h3 id="Bugzilla">
n18    </h2>n21    </h3>
n26      <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 function name</span></span>s.>horthand for two method name</span></span>s.
n30      Scrolling through the bug comments, we eventually come to an33      Scrolling through the bug comments, we eventually come to a
> link to the Mozilla mozilla-central source-code repository. chan> link to the mozilla-central source-code repository:
>geshe link goes to the 
n33<a href="https://hg.mozilla.org/mozilla-central/rev/0ac60eea3e4a"n36<a href="https://hg.mozilla.org/mozilla-central/rev/0ac60eea3e4a"
> title="https://hg.mozilla.org/mozilla-central/rev/0ac60eea3e4a">> title="https://hg.mozilla.org/mozilla-central/rev/0ac60eea3e4a">
>https://hg.mozilla.org/</a>mozilla-central/rev/0ac60eea3e4a>https://hg.mozilla.org/mozilla-central/rev/0ac60eea3e4a</a>
34 
35Following the link shows the changes that were made to the source
> code. The description of the change ("add Number.isInteger and N 
>umber.toInteger") confirms that this is indeed a change to theNum 
>ber 
tt38    <h3>
39      Source code
40    </h3>
41    <p>
42      Following the link shows the changes that were made in the 
 >source code. The description of the change ("add Number.isInteger
 > and Number.toInteger") confirms that this is indeed a change to 
 >the <code>Number</code> object, adding the <code>isInteger</code>
 > and <code>toInteger</code> methods.
43    </p>
44    <p>
45      The third link in the list of changed files points to the r
 >elevant change in the source code (<code>jsnum.cpp</code>). (The 
 >other two files contain test cases.)
46    </p>
47    <p>
48      Scrolling down, we see the actual change itself. A comment 
 >tells us which version of the ECMAScript standard implemented the
 > change ("// ES6 draft ES6 15.7.3.12"). If we search the internet
 > for "ecmascript harmony number isinteger" we find the descriptio
 >ns of the <code>isInteger</code> and <code>toInteger</code> metho
 >ds in the <a href="http://wiki.ecmascript.org/doku.php?id=harmony
 >:number.tointeger&amp;s=tointeger" title="http://wiki.ecmascript.
 >org/doku.php?id=harmony:number.tointeger&amp;s=tointeger">ECMAScr
 >ipt Harmony specification</a>. This is the reference on which we 
 >can base our changes in MDN
49    </p>
50    <h3>
51      MDN
52    </h3>
53    <p>
54      In MDN, we search for the JavaScript <a href="https://devel
 >oper.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/N
 >umber" title="https://developer.mozilla.org/en-US/docs/JavaScript
 >/Reference/Global_Objects/Number"><code>Number</code> object</a>.
 > In the Methods section of that page, we add the <code>isInteger<
 >/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
 >version_inline("16")</code> template. <span style="background-col
 >or:#ffff00;">(Why does the isNaN method have a page bug not the o
 >thers?)</span>
55    </p>
56    <p>
57      In the <a href="/en-US/docs/Firefox_16_for_developers" titl
 >e="/en-US/docs/Firefox_16_for_developers">Firefox 16 for develope
 >rs</a> article on MDN, we note that these methods have been added
 > to the <code>Number</code> object.
58    </p>
59    <h3>
60      Update Bugzilla
61    </h3>
62    <p>
63      Now that MDN has been updated to include the changes from t
 >he bug, we will update Bugzilla so people know what changed:
64    </p>
65    <ul>
66      <li>Remove the "dev-doc-needed" keyword.
67      </li>
68      <li>Add the "dev-doc-complete" keyword.
69      </li>
70      <li>Add a comment to the bug that includes links to any MDN
 > pages that were changed.
71      </li>
72      <li>&nbsp;
73      </li>
74    </ul>

Back to History