This is an automated email from the ASF dual-hosted git repository.
bertty pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-wayang.git
The following commit(s) were added to refs/heads/main by this push:
new 278cbdc [DOCS][UTEST] add todo's in wayang-api-scala-java
278cbdc is described below
commit 278cbdc4bd8e87863a7cb43bc68c52ca783039c0
Author: Bertty Contreras-Rojas <[email protected]>
AuthorDate: Wed Feb 9 23:42:14 2022 +0100
[DOCS][UTEST] add todo's in wayang-api-scala-java
Signed-off-by: bertty <[email protected]>
---
general-todos.md | 3 +++
.../code/main/scala/org/apache/wayang/api/DataQuanta.scala | 9 ++++++++-
.../main/scala/org/apache/wayang/api/DataQuantaBuilder.scala | 5 ++++-
.../code/main/scala/org/apache/wayang/api/JavaPlanBuilder.scala | 5 ++++-
.../code/main/scala/org/apache/wayang/api/PlanBuilder.scala | 5 ++++-
.../scala/org/apache/wayang/api/RecordDataQuantaBuilder.scala | 5 ++++-
.../code/main/scala/org/apache/wayang/api/graph/package.scala | 5 +++++
.../code/main/scala/org/apache/wayang/api/package.scala | 4 ++++
.../org/apache/wayang/api/util/DataQuantaBuilderDecorator.scala | 4 ++++
9 files changed, 40 insertions(+), 5 deletions(-)
diff --git a/general-todos.md b/general-todos.md
new file mode 100644
index 0000000..c01aa04
--- /dev/null
+++ b/general-todos.md
@@ -0,0 +1,3 @@
+# Here are all the To-Do's that are general
+
+## TODO: Explain the structure of the scala folder
\ No newline at end of file
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuanta.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuanta.scala
index ed1f426..019d7a2 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuanta.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuanta.scala
@@ -18,7 +18,10 @@
package org.apache.wayang.api
-
+/**
+ * TODO: add unitary test to the elements in the file
org.apache.wayang.api.DataQuanta.scala
+ * labels: unitary-test,todo
+ */
import _root_.java.lang.{Iterable => JavaIterable}
import _root_.java.util.function.{Consumer, IntUnaryOperator, BiFunction =>
JavaBiFunction, Function => JavaFunction}
import _root_.java.util.{Collection => JavaCollection}
@@ -925,6 +928,10 @@ class JoinedDataQuanta[Out0: ClassTag, Out1: ClassTag]
}
+/**
+ * TODO: add the documentation to the object org.apache.wayang.api.DataQuanta
+ * labels: documentation,todo
+ */
object DataQuanta {
def create[T](output: OutputSlot[T])(implicit planBuilder: PlanBuilder):
DataQuanta[_] =
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuantaBuilder.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuantaBuilder.scala
index 29b4965..ece3a50 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuantaBuilder.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/DataQuantaBuilder.scala
@@ -18,7 +18,10 @@
package org.apache.wayang.api
-
+/**
+ * TODO: add unitary test to the elements in the file
org.apache.wayang.api.DataQuantaBuilder.scala
+ * labels: unitary-test,todo
+ */
import java.util.function.{Consumer, IntUnaryOperator, Function =>
JavaFunction}
import java.util.{Collection => JavaCollection}
import org.apache.wayang.api.graph.{Edge, EdgeDataQuantaBuilder,
EdgeDataQuantaBuilderDecorator}
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/JavaPlanBuilder.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/JavaPlanBuilder.scala
index d21870a..42ea576 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/JavaPlanBuilder.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/JavaPlanBuilder.scala
@@ -17,7 +17,10 @@
*/
package org.apache.wayang.api
-
+/**
+ * TODO: add unitary test to the elements in the file
org.apache.wayang.api.JavaPlanBuilder.scala
+ * labels: unitary-test,todo
+ */
import java.util.{Collection => JavaCollection}
import org.apache.commons.lang3.Validate
import org.apache.wayang.api.util.DataQuantaBuilderCache
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/PlanBuilder.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/PlanBuilder.scala
index 3709f7f..9056401 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/PlanBuilder.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/PlanBuilder.scala
@@ -17,7 +17,10 @@
*/
package org.apache.wayang.api
-
+/**
+ * TODO: add unitary test to the elements in the file
org.apache.wayang.api.PlanBuilder.scala
+ * labels: unitary-test,todo
+ */
import org.apache.commons.lang3.Validate
import org.apache.wayang.api
import org.apache.wayang.basic.data.Record
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/RecordDataQuantaBuilder.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/RecordDataQuantaBuilder.scala
index 5af271f..4f0254d 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/RecordDataQuantaBuilder.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/RecordDataQuantaBuilder.scala
@@ -17,7 +17,10 @@
*/
package org.apache.wayang.api
-
+/**
+ * TODO: add unitary test to the elements in the file
org.apache.wayang.api.RecordDataQuantaBuilder.scala
+ * labels: unitary-test,todo
+ */
import org.apache.wayang.api.util.DataQuantaBuilderDecorator
import org.apache.wayang.basic.data.Record
import org.apache.wayang.basic.function.ProjectionDescriptor
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/graph/package.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/graph/package.scala
index e43fe81..8d0bf86 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/graph/package.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/graph/package.scala
@@ -25,6 +25,11 @@ import org.apache.wayang.basic.data.{Tuple2 => T2}
*/
package object graph {
+ /**
+ * TODO: add the description for the implicitis in
org.apache.wayang.api.graph
+ * labels: documentation,todo
+ */
+
type Vertex = java.lang.Long
type Edge = T2[Vertex, Vertex]
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/package.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/package.scala
index f17f5a5..715741c 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/package.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/package.scala
@@ -37,6 +37,10 @@ import scala.reflect.ClassTag
/**
* Provides implicits for the basic Wayang API.
*/
+/**
+ * TODO: add the documentation in the implicit of org.apache.wayang.api
+ * labels: documentation,todo
+ */
package object api {
implicit def basicDataUnitType[T](implicit classTag: ClassTag[T]):
BasicDataUnitType[T] = {
diff --git
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/util/DataQuantaBuilderDecorator.scala
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/util/DataQuantaBuilderDecorator.scala
index 5f1a976..e15a03f 100644
---
a/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/util/DataQuantaBuilderDecorator.scala
+++
b/wayang-api/wayang-api-scala-java/code/main/scala/org/apache/wayang/api/util/DataQuantaBuilderDecorator.scala
@@ -27,6 +27,10 @@ import org.apache.wayang.core.types.DataSetType
/**
* Utility to extend a [[DataQuantaBuilder]]'s functionality by decoration.
*/
+/**
+ * TODO: add the documentation in the methods of
org.apache.wayang.api.util.DataQuantaBuilderDecorator
+ * labels: documentation,todo
+ */
abstract class DataQuantaBuilderDecorator[This <: DataQuantaBuilder[This,
Out], Out]
(baseBuilder: DataQuantaBuilder[_, Out])
extends DataQuantaBuilder[This, Out] {
