From 3c3a5987740ec0d4bfd2d9ba537130b2dc1da38e Mon Sep 17 00:00:00 2001
From: Andy Stark <andrew.stark@redis.com>
Date: Wed, 15 Jan 2025 13:24:52 +0000
Subject: [PATCH 1/2] DOC-4464 examples for llen, lpop, lpush, lrange, rpop,
 and rpush

---
 doctests/cmds_list_test.go | 323 +++++++++++++++++++++++++++++++++++++
 1 file changed, 323 insertions(+)
 create mode 100644 doctests/cmds_list_test.go

diff --git a/doctests/cmds_list_test.go b/doctests/cmds_list_test.go
new file mode 100644
index 000000000..1906ce409
--- /dev/null
+++ b/doctests/cmds_list_test.go
@@ -0,0 +1,323 @@
+// EXAMPLE: cmds_list
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_cmd_llen() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "mylist")
+	// REMOVE_END
+
+	// STEP_START llen
+	lLenResult1, err := rdb.LPush(ctx, "mylist", "World").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lLenResult1) // >>> 1
+
+	lLenResult2, err := rdb.LPush(ctx, "mylist", "Hello").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lLenResult2) // >>> 2
+
+	lLenResult3, err := rdb.LLen(ctx, "mylist").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lLenResult3) // >>> 2
+	// STEP_END
+
+	// Output:
+	// 1
+	// 2
+	// 2
+}
+func ExampleClient_cmd_lpop() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "mylist")
+	// REMOVE_END
+
+	// STEP_START lpop
+	lPopResult1, err := rdb.RPush(ctx,
+		"mylist", "one", "two", "three", "four", "five",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lPopResult1) // >>> 5
+
+	lPopResult2, err := rdb.LPop(ctx, "mylist").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lPopResult2) // >>> one
+
+	lPopResult3, err := rdb.LPopCount(ctx, "mylist", 2).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lPopResult3) // >>> [two three]
+
+	lPopResult4, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lPopResult4) // >>> [four five]
+	// STEP_END
+
+	// Output:
+	// 5
+	// one
+	// [two three]
+	// [four five]
+}
+
+func ExampleClient_cmd_lpush() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "mylist")
+	// REMOVE_END
+
+	// STEP_START lpush
+	lPushResult1, err := rdb.LPush(ctx, "mylist", "World").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lPushResult1) // >>> 1
+
+	lPushResult2, err := rdb.LPush(ctx, "mylist", "Hello").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lPushResult2) // >>> 2
+
+	lPushResult3, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lPushResult3) // >>> [Hello World]
+	// STEP_END
+
+	// Output:
+	// 1
+	// 2
+	// [Hello World]
+}
+
+func ExampleClient_cmd_lrange() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "mylist")
+	// REMOVE_END
+
+	// STEP_START lrange
+	lRangeResult1, err := rdb.RPush(ctx, "mylist",
+		"one", "two", "three",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lRangeResult1) // >>> 3
+
+	lRangeResult2, err := rdb.LRange(ctx, "mylist", 0, 0).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lRangeResult2) // >>> [one]
+
+	lRangeResult3, err := rdb.LRange(ctx, "mylist", -3, 2).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lRangeResult3) // >>> [one two three]
+
+	lRangeResult4, err := rdb.LRange(ctx, "mylist", -100, 100).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lRangeResult4) // >>> [one two three]
+
+	lRangeResult5, err := rdb.LRange(ctx, "mylist", 5, 10).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(lRangeResult5) // >>> []
+	// STEP_END
+
+	// Output:
+	// 3
+	// [one]
+	// [one two three]
+	// [one two three]
+	// []
+}
+
+func ExampleClient_cmd_rpop() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "mylist")
+	// REMOVE_END
+
+	// STEP_START rpop
+	rPopResult1, err := rdb.RPush(ctx, "mylist",
+		"one", "two", "three", "four", "five",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(rPopResult1) // >>> 5
+
+	rPopResult2, err := rdb.RPop(ctx, "mylist").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(rPopResult2) // >>> five
+
+	rPopResult3, err := rdb.RPopCount(ctx, "mylist", 2).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(rPopResult3) // >>> [four three]
+
+	rPopResult4, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(rPopResult4) // >>> [one two]
+	// STEP_END
+
+	// Output:
+	// 5
+	// five
+	// [four three]
+	// [one two]
+}
+
+func ExampleClient_cmd_rpush() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "mylist")
+	// REMOVE_END
+
+	// STEP_START rpush
+	rPushResult1, err := rdb.RPush(ctx, "mylist", "Hello").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(rPushResult1) // >>> 1
+
+	rPushResult2, err := rdb.RPush(ctx, "mylist", "World").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(rPushResult2) // >>> 2
+
+	rPushResult3, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(rPushResult3) // >>> [Hello World]
+	// STEP_END
+
+	// Output:
+	// 1
+	// 2
+	// [Hello World]
+}

From 66d30dfac2c831a9e448f0129ef11652caec195c Mon Sep 17 00:00:00 2001
From: Andy Stark <andrew.stark@redis.com>
Date: Fri, 21 Feb 2025 13:03:29 +0000
Subject: [PATCH 2/2] DOC-4464 improved variable names

---
 doctests/cmds_list_test.go | 72 +++++++++++++++++++-------------------
 1 file changed, 36 insertions(+), 36 deletions(-)

diff --git a/doctests/cmds_list_test.go b/doctests/cmds_list_test.go
index 1906ce409..ee4a40a0c 100644
--- a/doctests/cmds_list_test.go
+++ b/doctests/cmds_list_test.go
@@ -25,29 +25,29 @@ func ExampleClient_cmd_llen() {
 	// REMOVE_END
 
 	// STEP_START llen
-	lLenResult1, err := rdb.LPush(ctx, "mylist", "World").Result()
+	lPushResult1, err := rdb.LPush(ctx, "mylist", "World").Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lLenResult1) // >>> 1
+	fmt.Println(lPushResult1) // >>> 1
 
-	lLenResult2, err := rdb.LPush(ctx, "mylist", "Hello").Result()
+	lPushResult2, err := rdb.LPush(ctx, "mylist", "Hello").Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lLenResult2) // >>> 2
+	fmt.Println(lPushResult2) // >>> 2
 
-	lLenResult3, err := rdb.LLen(ctx, "mylist").Result()
+	lLenResult, err := rdb.LLen(ctx, "mylist").Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lLenResult3) // >>> 2
+	fmt.Println(lLenResult) // >>> 2
 	// STEP_END
 
 	// Output:
@@ -69,7 +69,7 @@ func ExampleClient_cmd_lpop() {
 	// REMOVE_END
 
 	// STEP_START lpop
-	lPopResult1, err := rdb.RPush(ctx,
+	RPushResult, err := rdb.RPush(ctx,
 		"mylist", "one", "two", "three", "four", "five",
 	).Result()
 
@@ -77,31 +77,31 @@ func ExampleClient_cmd_lpop() {
 		panic(err)
 	}
 
-	fmt.Println(lPopResult1) // >>> 5
+	fmt.Println(RPushResult) // >>> 5
 
-	lPopResult2, err := rdb.LPop(ctx, "mylist").Result()
+	lPopResult, err := rdb.LPop(ctx, "mylist").Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lPopResult2) // >>> one
+	fmt.Println(lPopResult) // >>> one
 
-	lPopResult3, err := rdb.LPopCount(ctx, "mylist", 2).Result()
+	lPopCountResult, err := rdb.LPopCount(ctx, "mylist", 2).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lPopResult3) // >>> [two three]
+	fmt.Println(lPopCountResult) // >>> [two three]
 
-	lPopResult4, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+	lRangeResult, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lPopResult4) // >>> [four five]
+	fmt.Println(lRangeResult) // >>> [four five]
 	// STEP_END
 
 	// Output:
@@ -141,13 +141,13 @@ func ExampleClient_cmd_lpush() {
 
 	fmt.Println(lPushResult2) // >>> 2
 
-	lPushResult3, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+	lRangeResult, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lPushResult3) // >>> [Hello World]
+	fmt.Println(lRangeResult) // >>> [Hello World]
 	// STEP_END
 
 	// Output:
@@ -170,7 +170,7 @@ func ExampleClient_cmd_lrange() {
 	// REMOVE_END
 
 	// STEP_START lrange
-	lRangeResult1, err := rdb.RPush(ctx, "mylist",
+	RPushResult, err := rdb.RPush(ctx, "mylist",
 		"one", "two", "three",
 	).Result()
 
@@ -178,39 +178,39 @@ func ExampleClient_cmd_lrange() {
 		panic(err)
 	}
 
-	fmt.Println(lRangeResult1) // >>> 3
+	fmt.Println(RPushResult) // >>> 3
 
-	lRangeResult2, err := rdb.LRange(ctx, "mylist", 0, 0).Result()
+	lRangeResult1, err := rdb.LRange(ctx, "mylist", 0, 0).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lRangeResult2) // >>> [one]
+	fmt.Println(lRangeResult1) // >>> [one]
 
-	lRangeResult3, err := rdb.LRange(ctx, "mylist", -3, 2).Result()
+	lRangeResult2, err := rdb.LRange(ctx, "mylist", -3, 2).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lRangeResult3) // >>> [one two three]
+	fmt.Println(lRangeResult2) // >>> [one two three]
 
-	lRangeResult4, err := rdb.LRange(ctx, "mylist", -100, 100).Result()
+	lRangeResult3, err := rdb.LRange(ctx, "mylist", -100, 100).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lRangeResult4) // >>> [one two three]
+	fmt.Println(lRangeResult3) // >>> [one two three]
 
-	lRangeResult5, err := rdb.LRange(ctx, "mylist", 5, 10).Result()
+	lRangeResult4, err := rdb.LRange(ctx, "mylist", 5, 10).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(lRangeResult5) // >>> []
+	fmt.Println(lRangeResult4) // >>> []
 	// STEP_END
 
 	// Output:
@@ -235,7 +235,7 @@ func ExampleClient_cmd_rpop() {
 	// REMOVE_END
 
 	// STEP_START rpop
-	rPopResult1, err := rdb.RPush(ctx, "mylist",
+	rPushResult, err := rdb.RPush(ctx, "mylist",
 		"one", "two", "three", "four", "five",
 	).Result()
 
@@ -243,31 +243,31 @@ func ExampleClient_cmd_rpop() {
 		panic(err)
 	}
 
-	fmt.Println(rPopResult1) // >>> 5
+	fmt.Println(rPushResult) // >>> 5
 
-	rPopResult2, err := rdb.RPop(ctx, "mylist").Result()
+	rPopResult, err := rdb.RPop(ctx, "mylist").Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(rPopResult2) // >>> five
+	fmt.Println(rPopResult) // >>> five
 
-	rPopResult3, err := rdb.RPopCount(ctx, "mylist", 2).Result()
+	rPopCountResult, err := rdb.RPopCount(ctx, "mylist", 2).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(rPopResult3) // >>> [four three]
+	fmt.Println(rPopCountResult) // >>> [four three]
 
-	rPopResult4, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+	lRangeResult, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(rPopResult4) // >>> [one two]
+	fmt.Println(lRangeResult) // >>> [one two]
 	// STEP_END
 
 	// Output:
@@ -307,13 +307,13 @@ func ExampleClient_cmd_rpush() {
 
 	fmt.Println(rPushResult2) // >>> 2
 
-	rPushResult3, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
+	lRangeResult, err := rdb.LRange(ctx, "mylist", 0, -1).Result()
 
 	if err != nil {
 		panic(err)
 	}
 
-	fmt.Println(rPushResult3) // >>> [Hello World]
+	fmt.Println(lRangeResult) // >>> [Hello World]
 	// STEP_END
 
 	// Output: