From 4dc3eebc69734bba39b30d945dce8d1cbffcf14c Mon Sep 17 00:00:00 2001
From: Eddie Hung <eddie.hung@amd.com>
Date: Thu, 14 Nov 2024 12:55:43 -0800
Subject: [PATCH] Update javadoc as per review

Signed-off-by: Eddie Hung <eddie.hung@amd.com>
---
 src/com/xilinx/rapidwright/rwroute/GlobalSignalRouting.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/com/xilinx/rapidwright/rwroute/GlobalSignalRouting.java b/src/com/xilinx/rapidwright/rwroute/GlobalSignalRouting.java
index 07bcf957d..42cd8a11a 100644
--- a/src/com/xilinx/rapidwright/rwroute/GlobalSignalRouting.java
+++ b/src/com/xilinx/rapidwright/rwroute/GlobalSignalRouting.java
@@ -331,8 +331,8 @@ private static ClockRegion findCentroid(Net clk, Device device) {
     }
 
     /**
-     * Routes a static net (GND or VCC).
-     * @param pins A list of static pins to be routed.
+     * Routes pins from a static net (GND or VCC).
+     * @param pins A list of static pins to be routed (must all be on the same net).
      * @param getNodeState Lambda to get a node's status (available, unavailable, already in-use).
      * @param design The {@link Design} instance to use.
      * @param routeThruHelper The {@link RouteThruHelper} instance to use.