You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@gearpump.apache.org by "Manu Zhang (JIRA)" <ji...@apache.org> on 2016/04/06 05:33:25 UTC

[jira] [Commented] (GEARPUMP-11) Fix code styles by following practice of other projects

    [ https://issues.apache.org/jira/browse/GEARPUMP-11?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15227652#comment-15227652 ] 

Manu Zhang commented on GEARPUMP-11:
------------------------------------

FYI, Spark uses [scalastyle|http://www.scalastyle.org/] to check and enforce their style guide. 

> Fix code styles by following practice of other projects
> -------------------------------------------------------
>
>                 Key: GEARPUMP-11
>                 URL: https://issues.apache.org/jira/browse/GEARPUMP-11
>             Project: Apache Gearpump
>          Issue Type: Bug
>          Components: doc
>    Affects Versions: 0.8.0
>            Reporter: Sean Zhong
>            Assignee: Sean Zhong
>              Labels: doc
>             Fix For: 0.8.1
>
>   Original Estimate: 48h
>  Remaining Estimate: 48h
>
> *Motive:*
> 1. Scala is very flexible, if not having a code style guide in place, then it will easily be out of control. 
> 2. There are a lot of doc errors which cannot be parsed by Scaladoc and JavaDoc. We should fix them.
> *Suggestions:*
> 1. We can use Spark code style as major reference  https://github.com/databricks/scala-style-guide, with a few modifications. 
> 2. All doc errors should be fixed. 



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Re: [jira] [Commented] (GEARPUMP-11) Fix code styles by following practice of other projects

Posted by Sean Zhong <cl...@gmail.com>.
Great, I also find the similar thing. Let me try this scalastyle and see
whether it works out.

On Wed, Apr 6, 2016 at 11:33 AM, Manu Zhang (JIRA) <ji...@apache.org> wrote:

>
>     [
> https://issues.apache.org/jira/browse/GEARPUMP-11?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15227652#comment-15227652
> ]
>
> Manu Zhang commented on GEARPUMP-11:
> ------------------------------------
>
> FYI, Spark uses [scalastyle|http://www.scalastyle.org/] to check and
> enforce their style guide.
>
> > Fix code styles by following practice of other projects
> > -------------------------------------------------------
> >
> >                 Key: GEARPUMP-11
> >                 URL: https://issues.apache.org/jira/browse/GEARPUMP-11
> >             Project: Apache Gearpump
> >          Issue Type: Bug
> >          Components: doc
> >    Affects Versions: 0.8.0
> >            Reporter: Sean Zhong
> >            Assignee: Sean Zhong
> >              Labels: doc
> >             Fix For: 0.8.1
> >
> >   Original Estimate: 48h
> >  Remaining Estimate: 48h
> >
> > *Motive:*
> > 1. Scala is very flexible, if not having a code style guide in place,
> then it will easily be out of control.
> > 2. There are a lot of doc errors which cannot be parsed by Scaladoc and
> JavaDoc. We should fix them.
> > *Suggestions:*
> > 1. We can use Spark code style as major reference
> https://github.com/databricks/scala-style-guide, with a few modifications.
> > 2. All doc errors should be fixed.
>
>
>
> --
> This message was sent by Atlassian JIRA
> (v6.3.4#6332)
>