You are viewing a plain text version of this content. The canonical link for it is here.
Posted to mapreduce-issues@hadoop.apache.org by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org> on 2009/07/09 01:37:14 UTC

[jira] Created: (MAPREDUCE-742) Improve the java comments for the π examples

Improve the java comments for the &pi; examples
-----------------------------------------------

                 Key: MAPREDUCE-742
                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
             Project: Hadoop Map/Reduce
          Issue Type: Improvement
          Components: documentation, examples
            Reporter: Tsz Wo (Nicholas), SZE
            Assignee: Tsz Wo (Nicholas), SZE
            Priority: Minor


There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12729875#action_12729875 ] 

Tsz Wo (Nicholas), SZE commented on MAPREDUCE-742:
--------------------------------------------------

{noformat}
     [exec] -1 overall.  
     [exec] 
     [exec]     +1 @author.  The patch does not contain any @author tags.
     [exec] 
     [exec]     -1 tests included.  The patch doesn't appear to include any new or modified tests.
     [exec]                         Please justify why no new tests are needed for this patch.
     [exec]                         Also please list what manual steps were performed to verify this patch.
     [exec] 
     [exec]     +1 javadoc.  The javadoc tool did not generate any warning messages.
     [exec] 
     [exec]     +1 javac.  The applied patch does not increase the total number of javac compiler warnings.
     [exec] 
     [exec]     +1 findbugs.  The patch does not introduce any new Findbugs warnings.
     [exec] 
     [exec]     +1 release audit.  The applied patch does not increase the total number of release audit warnings.
{noformat}
The patch are mostly documentation changes.  The code changes are all related to output messages.  So I did not add new unit tests.

Tested Util.millis2String(long) manually as shown below:
{code}
  public static void main(String[] args) {
    long n = (1L << 32) - 1;
    System.out.println(Util.millis2String(n));
  }
{code}
Before the patch, the output is "49 days 17:02:47.-01"  which is incorrect.
After the patch, the correct value, "49 days 17:02:47.295", is printed.


> Improve the java comments for the π examples
> --------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>    Affects Versions: 0.21.0
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>             Fix For: 0.21.0
>
>         Attachments: m742_20090708.patch, m742_20090709.patch, m742_20090710.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tsz Wo (Nicholas), SZE updated MAPREDUCE-742:
---------------------------------------------

    Attachment: m742_20090708.patch

m742_20090708.patch:
- added comments to pi, bbp and distbbp.
- fix a bug in converting milliseconds to strings.

> Improve the java comments for the &pi; examples
> -----------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>         Attachments: m742_20090708.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Jakob Homan (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12729493#action_12729493 ] 

Jakob Homan commented on MAPREDUCE-742:
---------------------------------------

Looks good.  +1 with a couple nits: "emphasize on" should be just emphasize (line 23).  Also, the comment on IMPLEMENTATION_LIMIT seems a bit misleading.  Would something like: "Maximum digit to compute" emphasize that the value is a goal, rather than a limitation of the actual implementation?

> Improve the java comments for the π examples
> --------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>    Affects Versions: 0.21.0
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>             Fix For: 0.21.0
>
>         Attachments: m742_20090708.patch, m742_20090709.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tsz Wo (Nicholas), SZE updated MAPREDUCE-742:
---------------------------------------------

    Attachment: m742_20090709.patch

m742_20090709.patch: slightly changed the comments.

> Improve the java comments for the π examples
> --------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>    Affects Versions: 0.21.0
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>             Fix For: 0.21.0
>
>         Attachments: m742_20090708.patch, m742_20090709.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tsz Wo (Nicholas), SZE updated MAPREDUCE-742:
---------------------------------------------

    Affects Version/s: 0.21.0
        Fix Version/s: 0.21.0
              Summary: Improve the java comments for the π examples  (was: Improve the java comments for the &pi; examples)

> Improve the java comments for the π examples
> --------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>    Affects Versions: 0.21.0
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>             Fix For: 0.21.0
>
>         Attachments: m742_20090708.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Jakob Homan (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12729805#action_12729805 ] 

Jakob Homan commented on MAPREDUCE-742:
---------------------------------------

Looks great +1.

> Improve the java comments for the π examples
> --------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>    Affects Versions: 0.21.0
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>             Fix For: 0.21.0
>
>         Attachments: m742_20090708.patch, m742_20090709.patch, m742_20090710.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tsz Wo (Nicholas), SZE updated MAPREDUCE-742:
---------------------------------------------

    Attachment: m742_20090710.patch

Thanks, Jakob for the review comments.

m742_20090710.patch: rewrote the paragraphs about the limitation.

> Improve the java comments for the π examples
> --------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>    Affects Versions: 0.21.0
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>             Fix For: 0.21.0
>
>         Attachments: m742_20090708.patch, m742_20090709.patch, m742_20090710.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (MAPREDUCE-742) Improve the java comments for the π examples

Posted by "Tsz Wo (Nicholas), SZE (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/MAPREDUCE-742?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tsz Wo (Nicholas), SZE resolved MAPREDUCE-742.
----------------------------------------------

      Resolution: Fixed
    Hadoop Flags: [Reviewed]

I have committed this.

> Improve the java comments for the π examples
> --------------------------------------------
>
>                 Key: MAPREDUCE-742
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-742
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: documentation, examples
>    Affects Versions: 0.21.0
>            Reporter: Tsz Wo (Nicholas), SZE
>            Assignee: Tsz Wo (Nicholas), SZE
>            Priority: Minor
>             Fix For: 0.21.0
>
>         Attachments: m742_20090708.patch, m742_20090709.patch, m742_20090710.patch
>
>
> There are 3 examples, pi, bbp and distbbp for &pi; computation.  We should tell the difference between them.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.