From bdb0ded8be510d6f55bc5ddfc64302f4a2e7b3ce Mon Sep 17 00:00:00 2001
From: kercylan98 <kercylan@gmail.com>
Date: Mon, 12 Jun 2023 10:24:07 +0800
Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E4=BC=98=E5=8C=96?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 utils/g2d/doc.go | 2 ++
 utils/g2d/g2d.go | 6 ++++--
 2 files changed, 6 insertions(+), 2 deletions(-)
 create mode 100644 utils/g2d/doc.go

diff --git a/utils/g2d/doc.go b/utils/g2d/doc.go
new file mode 100644
index 0000000..2355893
--- /dev/null
+++ b/utils/g2d/doc.go
@@ -0,0 +1,2 @@
+// Package g2d 提供了大量用于2D计算的辅助函数及组件，例如图形搜索、辐射关系、适用于矩阵的计算函数等
+package g2d
diff --git a/utils/g2d/g2d.go b/utils/g2d/g2d.go
index 1446f22..4bd2c70 100644
--- a/utils/g2d/g2d.go
+++ b/utils/g2d/g2d.go
@@ -57,12 +57,14 @@ func PositionToInt(width, x, y int) int {
 	return y*width + x
 }
 
-// PositionToIntWithArray 将坐标转换为数字
+// PositionToIntWithArray 将坐标转换为二维数组的顺序位置
+//   - 需要确保x的取值范围必须小于width，或者将会得到不正确的值
 func PositionToIntWithArray(width int, xy [2]int) int {
 	return PositionToInt(width, xy[0], xy[1])
 }
 
-// PositionsToIntWithArray 将一组坐标转换为数字
+// PositionsToIntWithArray 将一组坐标转换为二维数组的顺序位置
+//   - 需要确保x的取值范围必须小于width，或者将会得到不正确的值
 func PositionsToIntWithArray(width int, xys ...[2]int) []int {
 	var result = make([]int, len(xys), len(xys))
 	for i := 0; i < len(xys); i++ {