[MINOR] Doc update

hossain-khan · Dec 22, 2024 · 5331d55 · 5331d55
1 parent e0082fa
commit 5331d55
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/src/main/kotlin/dev/hossain/githubstats/PrReviewerStatsService.kt b/src/main/kotlin/dev/hossain/githubstats/PrReviewerStatsService.kt
@@ -42,10 +42,11 @@ class PrReviewerStatsService constructor(
      * NOTE: If [AppConfig.botUserIds] is defined, then those users will be excluded from the review stats.
      *
      * ```
-     * Total Reviews by Sally: 24
-     * Bob -> 14 PRs reviewed by Sally;
-     * Alice -> 8 PRs reviewed by Sally;
-     * Charlie -> 2 PRs reviewed by Sally;
+     * Total reviews by Sally: 24
+     *
+     * Sally reviewed 14 PRs made by Bob
+     * Sally reviewed 8 PRs made by Alice
+     * Sally reviewed 2 PRs made by Charlie
      * ```
      */
     suspend fun reviewerStats(prReviewerUserId: String): ReviewerReviewStats {