Skip to content

Commit e0fedf6

Browse files
emkornfieldemkornfield
committed
ARROW-6304: [Java][Doc] Add a description to each module
* Note experimental and contrib modules as the first part of the description. Closes apache#5151 from emkornfield/add_tags and squashes the following commits: ddadfe9 <emkornfield> mark plasma experimental/contrib 857434e <emkornfield> fix typo 0b5f92d <Micah Kornfield> ARROW-6304: Add a description to each module and note experimental/contrib modules Lead-authored-by: emkornfield <emkornfield@gmail.com> Co-authored-by: Micah Kornfield <emkornfield@gmail.com> Signed-off-by: Micah Kornfield <emkornfield@gmail.com>
1 parent 1c8c218 commit e0fedf6

12 files changed

Lines changed: 12 additions & 0 deletions

File tree

‎java/adapter/avro/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525
<artifactId>arrow-avro</artifactId>
2626
<name>Arrow AVRO Adapter</name>
27+
<description>(Contrib/Experimental) A library for converting Avro data to Arrow data.</description>
2728
<url>http://maven.apache.org</url>
2829

2930
<dependencies>

‎java/adapter/jdbc/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
<artifactId>arrow-jdbc</artifactId>
2424
<name>Arrow JDBC Adapter</name>
25+
<description>(Contrib/Experimental)A library for converting JDBC data to Arrow data.</description>
2526
<url>http://maven.apache.org</url>
2627

2728
<dependencies>

‎java/adapter/orc/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@
8888
<groupId>org.apache.arrow.orc</groupId>
8989
<artifactId>arrow-orc</artifactId>
9090
<name>Arrow Orc Adapter</name>
91+
<description>(Experimental/Contrib)A JNI wrapper for the C++ ORC reader implementation.</description>
9192
<packaging>jar</packaging>
9293
<properties>
9394
<arrow.cpp.build.dir>../../../cpp/release-build/</arrow.cpp.build.dir>

‎java/algorithm/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
</parent>
1919
<artifactId>arrow-algorithm</artifactId>
2020
<name>Arrow Algorithms</name>
21+
<description>(Experimental/Contrib) A collection of algorithms for working with ValueVectors.</description>
2122

2223
<dependencies>
2324
<dependency>

‎java/flight/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
<artifactId>arrow-flight</artifactId>
1818
<name>Arrow Flight</name>
19+
<description>(Experimental)An RPC mechanism for transferring ValueVectors.</description>
1920
<packaging>jar</packaging>
2021

2122
<properties>

‎java/format/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
<artifactId>arrow-format</artifactId>
2222
<packaging>jar</packaging>
2323
<name>Arrow Format</name>
24+
<description>Generated Java files from the IPC Flatbuffer definitions.</description>
2425

2526
<properties>
2627
<flatc.download.skip>false</flatc.download.skip>

‎java/gandiva/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
<artifactId>arrow-gandiva</artifactId>
2222
<packaging>jar</packaging>
2323
<name>Arrow Gandiva</name>
24+
<description>Java wrappers around the native Gandiva SQL expression compiler.</description>
2425
<properties>
2526
<maven.compiler.source>1.8</maven.compiler.source>
2627
<maven.compiler.target>1.8</maven.compiler.target>

‎java/memory/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
</parent>
1919
<artifactId>arrow-memory</artifactId>
2020
<name>Arrow Memory</name>
21+
<description>Core off-heap memory management libraries for Arrow ValueVectors.</description>
2122

2223
<dependencies>
2324
<dependency>

‎java/performance/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
<artifactId>arrow-performance</artifactId>
2020
<packaging>jar</packaging>
2121
<name>Arrow Performance Benchmarks</name>
22+
<description>JMH Performance benchmarks for other Arrow libraries.</description>
2223

2324
<dependencies>
2425
<dependency>

‎java/plasma/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
</parent>
1919
<artifactId>arrow-plasma</artifactId>
2020
<name>Arrow Plasma Client</name>
21+
<description>(Experimental/Contrib) Java client for the Plasma object store.</description>
2122
<build>
2223
<plugins>
2324
<plugin>

0 commit comments

Comments
 (0)