Skip to content

Commit 6c29896

Browse files
committed
docs: Add documentation to Wayang API graph package object
1 parent 92cff92 commit 6c29896

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

  • wayang-api/wayang-api-scala-java/src/main/scala/org/apache/wayang/api/graph

wayang-api/wayang-api-scala-java/src/main/scala/org/apache/wayang/api/graph/package.scala

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,18 @@ package org.apache.wayang.api
2121
import org.apache.wayang.basic.data.{Tuple2 => T2}
2222

2323
/**
24-
* Provides implicits for Wayang's graph API.
25-
*/
24+
* Provides implicit conversions and type aliases for Apache Wayang's graph API.
25+
*
26+
* This package object defines core type aliases used in graph processing pipelines:
27+
* - Vertex: represents a graph node as a Long identifier
28+
* - Edge: represents a directed connection between two vertices
29+
* - PageRank: represents a vertex with its computed PageRank score
30+
*
31+
* These types support graph analytics operations within Wayang's
32+
* cross-platform execution model.
33+
*/
2634
package object graph {
2735

28-
/**
29-
* TODO: add the description for the implicitis in org.apache.wayang.api.graph
30-
* labels: documentation,todo
31-
*/
32-
3336
type Vertex = java.lang.Long
3437

3538
type Edge = T2[Vertex, Vertex]

0 commit comments

Comments
 (0)