lidavidm commented on code in PR #41825: URL: https://github.com/apache/arrow/pull/41825#discussion_r1626804974
########## docs/source/developers/java/development.rst: ########## @@ -110,7 +110,45 @@ integration tests, you would do: Code Style ========== -Java code style is enforced with Checkstyle. The configuration is located at `checkstyle`_. +The current Java code styles are configured as follows: + +- Indent: Tabs & spaces (2 spaces per tab) +- Google Java Format: Reformats Java source code to comply with `Google Java Style`_. +- Configure license headers for Java & XML files + + +Java code style is checked by `Spotless`_ during the build, and the continuous integration build will verify +that changes adhere to the style guide. + +Automatically fixing code style issues +-------------------------------------- + +- You can also just check the style without building the project with ``mvn spotless:check``. Review Comment: ```suggestion - You can check the style without building the project with ``mvn spotless:check``. ``` ########## docs/source/developers/java/development.rst: ########## @@ -110,7 +110,45 @@ integration tests, you would do: Code Style ========== -Java code style is enforced with Checkstyle. The configuration is located at `checkstyle`_. +The current Java code styles are configured as follows: + +- Indent: Tabs & spaces (2 spaces per tab) +- Google Java Format: Reformats Java source code to comply with `Google Java Style`_. +- Configure license headers for Java & XML files Review Comment: Can we just say, we follow Google Java Style with Apache license headers? ########## docs/source/developers/java/development.rst: ########## @@ -110,7 +110,45 @@ integration tests, you would do: Code Style ========== -Java code style is enforced with Checkstyle. The configuration is located at `checkstyle`_. +The current Java code styles are configured as follows: + +- Indent: Tabs & spaces (2 spaces per tab) +- Google Java Format: Reformats Java source code to comply with `Google Java Style`_. +- Configure license headers for Java & XML files + + +Java code style is checked by `Spotless`_ during the build, and the continuous integration build will verify +that changes adhere to the style guide. + +Automatically fixing code style issues +-------------------------------------- + +- You can also just check the style without building the project with ``mvn spotless:check``. +- The Java code style can be corrected from the command line by using the following commands: ``mvn spotless:apply``. Review Comment: ```suggestion - You can autoformat the source with ``mvn spotless:apply``. ``` ########## docs/source/developers/java/development.rst: ########## @@ -110,7 +110,45 @@ integration tests, you would do: Code Style ========== -Java code style is enforced with Checkstyle. The configuration is located at `checkstyle`_. +The current Java code styles are configured as follows: + +- Indent: Tabs & spaces (2 spaces per tab) +- Google Java Format: Reformats Java source code to comply with `Google Java Style`_. +- Configure license headers for Java & XML files + + +Java code style is checked by `Spotless`_ during the build, and the continuous integration build will verify +that changes adhere to the style guide. + +Automatically fixing code style issues +-------------------------------------- + +- You can also just check the style without building the project with ``mvn spotless:check``. +- The Java code style can be corrected from the command line by using the following commands: ``mvn spotless:apply``. + +.. code-block:: bash Review Comment: ```suggestion Example: .. code-block:: bash ``` ########## java/.mvn/develocity.xml: ########## Review Comment: Is this move correct? ########## docs/source/developers/java/development.rst: ########## @@ -110,7 +110,45 @@ integration tests, you would do: Code Style ========== -Java code style is enforced with Checkstyle. The configuration is located at `checkstyle`_. +The current Java code styles are configured as follows: + +- Indent: Tabs & spaces (2 spaces per tab) +- Google Java Format: Reformats Java source code to comply with `Google Java Style`_. +- Configure license headers for Java & XML files + + +Java code style is checked by `Spotless`_ during the build, and the continuous integration build will verify +that changes adhere to the style guide. + +Automatically fixing code style issues +-------------------------------------- + +- You can also just check the style without building the project with ``mvn spotless:check``. +- The Java code style can be corrected from the command line by using the following commands: ``mvn spotless:apply``. + +.. code-block:: bash + + The following files had format violations: + src/main/java/org/apache/arrow/algorithm/rank/VectorRank.java + @@ -15,7 +15,6 @@ + ·*·limitations·under·the·License. + ·*/ + + - + package·org.apache.arrow.algorithm.rank; + + import·java.util.stream.IntStream; + Run 'mvn spotless:apply' to fix these violations. + +Code Formatter for Intellij IDEA and Eclipse +-------------------------------------------- + +Follow the instructions for: + +- `Eclipse`_ +- `IntelliJ`_ + +Code style enforced with both Spotless and Checkstyle. The configuration is located at `checkstyle`_. Review Comment: ```suggestion Checkstyle ---------- Checkstyle is also used for general linting. The configuration is located at `checkstyle`_. ``` ########## docs/source/developers/java/development.rst: ########## @@ -110,7 +110,45 @@ integration tests, you would do: Code Style ========== -Java code style is enforced with Checkstyle. The configuration is located at `checkstyle`_. +The current Java code styles are configured as follows: + +- Indent: Tabs & spaces (2 spaces per tab) +- Google Java Format: Reformats Java source code to comply with `Google Java Style`_. +- Configure license headers for Java & XML files + + +Java code style is checked by `Spotless`_ during the build, and the continuous integration build will verify +that changes adhere to the style guide. + +Automatically fixing code style issues +-------------------------------------- + +- You can also just check the style without building the project with ``mvn spotless:check``. +- The Java code style can be corrected from the command line by using the following commands: ``mvn spotless:apply``. + +.. code-block:: bash + + The following files had format violations: + src/main/java/org/apache/arrow/algorithm/rank/VectorRank.java + @@ -15,7 +15,6 @@ + ·*·limitations·under·the·License. + ·*/ + + - + package·org.apache.arrow.algorithm.rank; + + import·java.util.stream.IntStream; + Run 'mvn spotless:apply' to fix these violations. + +Code Formatter for Intellij IDEA and Eclipse +-------------------------------------------- + +Follow the instructions for: Review Comment: ```suggestion Follow the instructions to set up google-java-format for: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
