From c3cfc01cf6ab2fc6b252b870d51da4e5b0aecd30 Mon Sep 17 00:00:00 2001
From: John Guo <john@johng.cn>
Date: Thu, 27 Jun 2024 21:12:51 +0800
Subject: [PATCH] refactor(container/gring): mark deprecated, package
 `container/gring` will not be maintained in future (#3665)

---
 container/glist/glist.go       | 3 ++-
 container/gring/gring.go       | 6 ++++++
 container/gset/gset_any_set.go | 1 +
 container/gset/gset_int_set.go | 1 +
 container/gset/gset_str_set.go | 1 +
 container/gvar/gvar.go         | 2 +-
 6 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/container/glist/glist.go b/container/glist/glist.go
index 1c6212eae..9b5424666 100644
--- a/container/glist/glist.go
+++ b/container/glist/glist.go
@@ -5,7 +5,8 @@
 // You can obtain one at https://github.com/gogf/gf.
 //
 
-// Package glist provides most commonly used doubly linked list container which also supports concurrent-safe/unsafe switch feature.
+// Package glist provides most commonly used doubly linked list container which also supports
+// concurrent-safe/unsafe switch feature.
 package glist
 
 import (
diff --git a/container/gring/gring.go b/container/gring/gring.go
index 160fbf553..3700bd044 100644
--- a/container/gring/gring.go
+++ b/container/gring/gring.go
@@ -5,6 +5,8 @@
 // You can obtain one at https://github.com/gogf/gf.
 
 // Package gring provides a concurrent-safe/unsafe ring(circular lists).
+//
+// Deprecated.
 package gring
 
 import (
@@ -15,6 +17,8 @@ import (
 )
 
 // Ring is a struct of ring structure.
+//
+// Deprecated.
 type Ring struct {
 	mu    *rwmutex.RWMutex
 	ring  *ring.Ring  // Underlying ring.
@@ -31,6 +35,8 @@ type internalRingItem struct {
 // New creates and returns a Ring structure of `cap` elements.
 // The optional parameter `safe` specifies whether using this structure in concurrent safety,
 // which is false in default.
+//
+// Deprecated.
 func New(cap int, safe ...bool) *Ring {
 	return &Ring{
 		mu:    rwmutex.New(safe...),
diff --git a/container/gset/gset_any_set.go b/container/gset/gset_any_set.go
index 31d420e42..5bc58a27b 100644
--- a/container/gset/gset_any_set.go
+++ b/container/gset/gset_any_set.go
@@ -16,6 +16,7 @@ import (
 	"github.com/gogf/gf/v2/util/gconv"
 )
 
+// Set is consisted of interface{} items.
 type Set struct {
 	mu   rwmutex.RWMutex
 	data map[interface{}]struct{}
diff --git a/container/gset/gset_int_set.go b/container/gset/gset_int_set.go
index eb7835684..08d979869 100644
--- a/container/gset/gset_int_set.go
+++ b/container/gset/gset_int_set.go
@@ -15,6 +15,7 @@ import (
 	"github.com/gogf/gf/v2/util/gconv"
 )
 
+// IntSet is consisted of int items.
 type IntSet struct {
 	mu   rwmutex.RWMutex
 	data map[int]struct{}
diff --git a/container/gset/gset_str_set.go b/container/gset/gset_str_set.go
index 2893e2b36..6b880a74f 100644
--- a/container/gset/gset_str_set.go
+++ b/container/gset/gset_str_set.go
@@ -17,6 +17,7 @@ import (
 	"github.com/gogf/gf/v2/util/gconv"
 )
 
+// StrSet is consisted of string items.
 type StrSet struct {
 	mu   rwmutex.RWMutex
 	data map[string]struct{}
diff --git a/container/gvar/gvar.go b/container/gvar/gvar.go
index 3b77e78a7..3f7781421 100644
--- a/container/gvar/gvar.go
+++ b/container/gvar/gvar.go
@@ -4,7 +4,7 @@
 // If a copy of the MIT was not distributed with this file,
 // You can obtain one at https://github.com/gogf/gf.
 
-// Package gvar provides an universal variable type, like generics.
+// Package gvar provides an universal variable type, like runtime generics.
 package gvar
 
 import (