From 6c29896545e44238538b3e8473c46228e534f64f Mon Sep 17 00:00:00 2001 From: BoddedaAjay Date: Thu, 26 Mar 2026 08:41:21 +0530 Subject: [PATCH] docs: Add documentation to Wayang API graph package object --- .../org/apache/wayang/api/graph/package.scala | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/wayang-api/wayang-api-scala-java/src/main/scala/org/apache/wayang/api/graph/package.scala b/wayang-api/wayang-api-scala-java/src/main/scala/org/apache/wayang/api/graph/package.scala index 8d0bf86fe..bc8ebc392 100644 --- a/wayang-api/wayang-api-scala-java/src/main/scala/org/apache/wayang/api/graph/package.scala +++ b/wayang-api/wayang-api-scala-java/src/main/scala/org/apache/wayang/api/graph/package.scala @@ -21,15 +21,18 @@ package org.apache.wayang.api import org.apache.wayang.basic.data.{Tuple2 => T2} /** - * Provides implicits for Wayang's graph API. - */ + * Provides implicit conversions and type aliases for Apache Wayang's graph API. + * + * This package object defines core type aliases used in graph processing pipelines: + * - Vertex: represents a graph node as a Long identifier + * - Edge: represents a directed connection between two vertices + * - PageRank: represents a vertex with its computed PageRank score + * + * These types support graph analytics operations within Wayang's + * cross-platform execution model. + */ 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]