From 763050e10e90d849ab088e2f2e171f9ff7f66778 Mon Sep 17 00:00:00 2001
From: Dan Gillis <gilcrest@gmail.com>
Date: Sun, 19 Sep 2021 14:57:53 -0400
Subject: [PATCH] Add comments

Add Stat struct comment and correct Stat.MaxConns method comment
---
 pgxpool/stat.go | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/pgxpool/stat.go b/pgxpool/stat.go
index a4b2e750..336be42d 100644
--- a/pgxpool/stat.go
+++ b/pgxpool/stat.go
@@ -6,6 +6,7 @@ import (
 	"github.com/jackc/puddle"
 )
 
+// Stat is a snapshot of Pool statistics.
 type Stat struct {
 	s *puddle.Stat
 }
@@ -50,7 +51,7 @@ func (s *Stat) IdleConns() int32 {
 	return s.s.IdleResources()
 }
 
-// MaxResources returns the maximum size of the pool.
+// MaxConns returns the maximum size of the pool.
 func (s *Stat) MaxConns() int32 {
 	return s.s.MaxResources()
 }