mirror of https://github.com/redis/go-redis.git synced 2025-04-16 09:23:06 +03:00

History

andy-stark-redis 79ed39adcc

DOC-4230 list doc code examples (#3110 )

* DOC-4230 list tutorial examples

* DOC-4230 added missing printout comment

* DOC-4230 added set datatype examples

* Revert "DOC-4230 added set datatype examples"

This reverts commit 4f208aaf7bf26c60f677ef872b794e0d641337cc.

---------

Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>

2024-09-12 13:54:42 +03:00

hash_tutorial_test.go

Doc 4226 hash tces (#3106 )

2024-09-12 11:45:38 +03:00

list_tutorial_test.go

DOC-4230 list doc code examples (#3110 )

2024-09-12 13:54:42 +03:00

lpush_lrange_test.go

Format code and fix go vet (#2696 )

2023-09-20 14:03:44 +03:00

README.md

Adds testable examples to be automatically pulled in redis.io docs (#2601 )

2023-05-31 14:22:55 +01:00

set_get_test.go

Format code and fix go vet (#2696 )

2023-09-20 14:03:44 +03:00

string_example_test.go

DOC-4213 string code examples (#3102 )

2024-09-06 14:49:25 +03:00

README.md

Command examples for redis.io

These examples appear on the Redis documentation site as part of the tabbed examples interface.

How to add examples

Create a Go test file with a meaningful name in the current folder.
Create a single method prefixed with Example and write your test in it.
Determine the id for the example you're creating and add it as the first line of the file: // EXAMPLE: set_and_get.
We're using the Testable Examples feature of Go to test the desired output has been written to stdout.

Special markup

See https://github.com/redis-stack/redis-stack-website#readme for more details.

How to test the examples

Start a Redis server locally on port 6379
CD into the doctests directory
Run go test to test all examples in the directory.
Run go test filename.go to test a single file