You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@giraph.apache.org by "Avery Ching (JIRA)" <ji...@apache.org> on 2011/08/31 19:28:10 UTC

[jira] [Created] (GIRAPH-21) Revise CODE_CONVENTIONS

Revise CODE_CONVENTIONS
-----------------------

                 Key: GIRAPH-21
                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
             Project: Giraph
          Issue Type: Improvement
            Reporter: Avery Ching
            Priority: Minor


Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Resolved] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Jakob Homan (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jakob Homan resolved GIRAPH-21.
-------------------------------

    Resolution: Fixed

I've committed this. Resolving.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Assignee: Avery Ching
>            Priority: Minor
>         Attachments: GIRAPH-21.diff
>
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Assigned] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Avery Ching (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Avery Ching reassigned GIRAPH-21:
---------------------------------

    Assignee: Avery Ching

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Assignee: Avery Ching
>            Priority: Minor
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Avery Ching (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13094768#comment-13094768 ] 

Avery Ching commented on GIRAPH-21:
-----------------------------------

I'll definitely let this continue to flesh out, but 80 chars and 2 spaces is fine with me.  I will modify/augment the CODE_CONVENTIONS file and then when we have consensus, I will commit as well as try to get Eclipse to help me change the source to match. Btw, it seems like Owen doesn't like abbreviations, so we can add that here too. =)

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Priority: Minor
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13094718#comment-13094718 ] 

Owen O'Malley commented on GIRAPH-21:
-------------------------------------

Where I almost always use emacs and so anything longer than 79 characters is annoying.

I generally like 2 space indent, but it isn't a huge deal to me.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Priority: Minor
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Sebastian Schelter (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13104363#comment-13104363 ] 

Sebastian Schelter commented on GIRAPH-21:
------------------------------------------

I'm currently reading a lot of giraph code as I'm evaluating it for usage in research and I must admit that 80 chars per line really makes the code hard to read. 

Although I'm not involved with your project, I'd suggest 2 space indent and 120 chars per line. Mahout uses the same.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Assignee: Avery Ching
>            Priority: Minor
>         Attachments: GIRAPH-21.diff
>
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Henry Saputra (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13094731#comment-13094731 ] 

Henry Saputra commented on GIRAPH-21:
-------------------------------------

I like the 2 space indent, spaces only, and max char 100 or 80.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Priority: Minor
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

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

Jakob Homan commented on GIRAPH-21:
-----------------------------------

I usually think of 80 chars as being 80 + 3 or 4 character buffer for semicolons, parens, etc.  It's a good rule to have, but exceptions need to be made.  The complicating factor is that with a 80 chars + 4 spaces per indent + lots of complicated Java type definitions (what I wouldn't give for Scala's type aliases), the code gets pretty craggy, pretty fast.  Going to two spaces would probably have a bigger impact than it might first appear, but I don't have a strong opinion.  

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Priority: Minor
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Jake Mannix (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13101032#comment-13101032 ] 

Jake Mannix commented on GIRAPH-21:
-----------------------------------

80 chars and 2 spaces from me!  I'd accept 100 chars, but 2 is much better than 4 IMO for spacing.  Import ordering: strict alpha?  

But I'll go with anything really, esp. if there is a checkstyle.xml file which makes me not have to think about it.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Assignee: Avery Ching
>            Priority: Minor
>         Attachments: GIRAPH-21.diff
>
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

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

Jakob Homan commented on GIRAPH-21:
-----------------------------------

+1.  This looks reasonable.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Assignee: Avery Ching
>            Priority: Minor
>         Attachments: GIRAPH-21.diff
>
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Hyunsik Choi (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13094757#comment-13094757 ] 

Hyunsik Choi commented on GIRAPH-21:
------------------------------------

I prefer 80 chars per line and 2 space indent.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Priority: Minor
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (GIRAPH-21) Revise CODE_CONVENTIONS

Posted by "Avery Ching (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/GIRAPH-21?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Avery Ching updated GIRAPH-21:
------------------------------

    Attachment: GIRAPH-21.diff

First proposal of the developer suggested code conventions.

> Revise CODE_CONVENTIONS
> -----------------------
>
>                 Key: GIRAPH-21
>                 URL: https://issues.apache.org/jira/browse/GIRAPH-21
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Avery Ching
>            Assignee: Avery Ching
>            Priority: Minor
>         Attachments: GIRAPH-21.diff
>
>
> Currently there is a CODE_CONVENTIONS file in the base path of Giraph.  It's fairly sparse and we have been assuming an 80 char limit per line.  It's good to have common conventions so that the code doesn't get too messy.  Does anyone have any opinions on this now?  Probably best to tackle early and then have something to follow.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira