Skip to content

Commit

Permalink
typo #4992
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin committed Aug 23, 2018
1 parent be5e56d commit 289c667
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/sphinx-guides/source/developers/coding-style.rst
Expand Up @@ -59,8 +59,8 @@ Format Code You Changed with Netbeans

As you probably gathered from the :doc:`dev-environment` section, IQSS has standardized on Netbeans. It is much appreciated when you format your code (but only the code you touched!) using the out-of-the-box Netbeans configuration. If you have created an entirely new Java class, you can just click Source -> Format. If you are adjusting code in an existing class, highlight the code you changed and then click Source -> Format. Keeping the "diff" in your pull requests small makes them easier to code review.

The Netbeans formatting syntax appears not to be documented anywhere, however from an initial approixmation `astyle --mode=java --style=attach --add-braces ${source_file}` is reasonably close.
If `astyle` is not installed on your system, it is available from `<http://astyle.sourceforge.net/>`_.
The Netbeans formatting syntax appears not to be documented anywhere, however from an initial approximation `astyle --mode=java --style=attach --add-braces ${source_file}` is reasonably close.
If `astyle` is not installed on your system, it is available from `<http://astyle.sourceforge.net>`_.

We would like to someday automate the detection and possibly correction of code that hasn't been formatted using our house style (the default Netbeans style). We've heard that https://maven.apache.org/plugins/maven-checkstyle-plugin/ can do this but we would be happy to see a pull request in this area, especially if it also hooks up to our builds at https://travis-ci.org/IQSS/dataverse .

Expand Down

0 comments on commit 289c667

Please sign in to comment.