From 1001d50c04c783b4044aacb014b782f2f1be392e Mon Sep 17 00:00:00 2001
From: kercylan98 <kercylan@gmail.com>
Date: Wed, 5 Jul 2023 14:26:10 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=8E=92=E8=A1=8C=E6=A6=9C=20GetRank?=
 =?UTF-8?q?=20=E5=87=BD=E6=95=B0=E5=A2=9E=E5=8A=A0=E6=B3=A8=E9=87=8A?=
 =?UTF-8?q?=EF=BC=8C=E6=8F=90=E7=A4=BA=E6=8E=92=E5=90=8D=E4=BB=8E=200=20?=
 =?UTF-8?q?=E5=BC=80=E5=A7=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 game/builtin/ranking_list.go | 1 +
 game/ranking_list.go         | 1 +
 2 files changed, 2 insertions(+)

diff --git a/game/builtin/ranking_list.go b/game/builtin/ranking_list.go
index 80139c3..9d144e0 100644
--- a/game/builtin/ranking_list.go
+++ b/game/builtin/ranking_list.go
@@ -87,6 +87,7 @@ func (slf *RankingList[CompetitorID, Score]) Size() int {
 }
 
 // GetRank 获取竞争者排名
+//   - 排名从 0 开始
 func (slf *RankingList[CompetitorID, Score]) GetRank(competitorId CompetitorID) (int, error) {
 	competitorScore, exist := slf.competitors.GetExist(competitorId)
 	if !exist {
diff --git a/game/ranking_list.go b/game/ranking_list.go
index a74f145..b20479e 100644
--- a/game/ranking_list.go
+++ b/game/ranking_list.go
@@ -12,6 +12,7 @@ type RankingList[CompetitorID comparable, Score generic.Ordered] interface {
 	// Size 获取竞争者数量
 	Size() int
 	// GetRank 获取竞争者排名
+	//  - 排名从 0 开始
 	GetRank(competitorId CompetitorID) (int, error)
 	// GetCompetitor 获取特定排名的竞争者
 	GetCompetitor(rank int) (CompetitorID, error)