raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

=doc: Document code block style difference from style guide #3106

Browse source
This commit is contained in:
Endre Sándor Varga 2013-07-02 12:25:06 +02:00
parent 1cca2b85e3
commit 01d5579a83
1 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
akka-docs/rst/dev/developer-guidelines.rst
View file

@ -10,7 +10,18 @@ Developer Guidelines
Code Style
----------
The Akka code style follows the `Scala Style Guide <http://docs.scala-lang.org/style/>`_ .
The Akka code style follows the `Scala Style Guide <http://docs.scala-lang.org/style/>`_ . The only exception is the
style of block comments:
.. code-block:: scala
/**
* Style mandated by "Scala Style Guide"
*/
/**
* Style adopted in the Akka codebase
*/
Akka is using ``Scalariform`` to format the source code as part of the build. So just hack away and then run ``sbt compile`` and it will reformat the code according to Akka standards.