[
https://issues.apache.org/jira/browse/GEARPUMP-11?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Sean Zhong updated GEARPUMP-11:
-------------------------------
Affects Version/s: 0.8.0
Fix Version/s: 0.8.1
Component/s: doc
> 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)